* @license AGPL-3.0-or-later https://www.gnu.org/licenses/agpl-3.0.html
- * @version 1.0.0
+ * @version GIT: 1.0.0
* @link https://github.com/ConductionNL/SoftwareCatalog
*/
class ProgressTracker
@@ -37,39 +37,39 @@ class ProgressTracker
* Operation phases and their relative weights for progress calculation
*/
private const PHASES = [
- 'initializing' => ['weight' => 5, 'description' => 'Initializing'],
- 'validating' => ['weight' => 5, 'description' => 'Validating file'],
- 'parsing' => ['weight' => 10, 'description' => 'Parsing ArchiMate file'],
- 'analyzing' => ['weight' => 5, 'description' => 'Analyzing structure'],
- 'caching' => ['weight' => 10, 'description' => 'Loading existing objects'],
- 'processing_elements' => ['weight' => 30, 'description' => 'Processing elements'],
+ 'initializing' => ['weight' => 5, 'description' => 'Initializing'],
+ 'validating' => ['weight' => 5, 'description' => 'Validating file'],
+ 'parsing' => ['weight' => 10, 'description' => 'Parsing ArchiMate file'],
+ 'analyzing' => ['weight' => 5, 'description' => 'Analyzing structure'],
+ 'caching' => ['weight' => 10, 'description' => 'Loading existing objects'],
+ 'processing_elements' => ['weight' => 30, 'description' => 'Processing elements'],
'processing_relationships' => ['weight' => 15, 'description' => 'Processing relationships'],
'processing_organizations' => ['weight' => 10, 'description' => 'Processing organizations'],
- 'processing_views' => ['weight' => 10, 'description' => 'Processing views'],
- 'finalizing' => ['weight' => 5, 'description' => 'Finalizing import'],
- 'completed' => ['weight' => 0, 'description' => 'Completed']
+ 'processing_views' => ['weight' => 10, 'description' => 'Processing views'],
+ 'finalizing' => ['weight' => 5, 'description' => 'Finalizing import'],
+ 'completed' => ['weight' => 0, 'description' => 'Completed'],
];
/**
* Current progress state
- *
+ *
* @var array
*/
private array $progress = [
- 'operation_id' => null,
- 'operation_type' => null,
- 'phase' => 'initializing',
- 'phase_description' => 'Initializing',
- 'total_items' => 0,
- 'processed_items' => 0,
- 'current_item_type' => null,
- 'current_item_name' => null,
- 'percentage' => 0,
- 'start_time' => null,
+ 'operation_id' => null,
+ 'operation_type' => null,
+ 'phase' => 'initializing',
+ 'phase_description' => 'Initializing',
+ 'total_items' => 0,
+ 'processed_items' => 0,
+ 'current_item_type' => null,
+ 'current_item_name' => null,
+ 'percentage' => 0,
+ 'start_time' => null,
'estimated_completion' => null,
- 'errors' => [],
- 'warnings' => [],
- 'statistics' => []
+ 'errors' => [],
+ 'warnings' => [],
+ 'statistics' => [],
];
/**
@@ -82,59 +82,62 @@ public function __construct(
private readonly ISession $session,
private readonly LoggerInterface $logger
) {
- }
+ }//end __construct()
/**
* Start tracking a new operation
*
* @param string $operationType Type of operation (import, export)
* @param array $options Operation options and metadata
- *
+ *
* @return string Unique operation ID
*/
- public function startOperation(string $operationType, array $options = []): string
+ public function startOperation(string $operationType, array $options=[]): string
{
- $operationId = uniqid($operationType . '_', true);
-
+ $operationId = uniqid(prefix: $operationType.'_', more_entropy: true);
+
$this->progress = [
- 'operation_id' => $operationId,
- 'operation_type' => $operationType,
- 'phase' => 'initializing',
- 'phase_description' => self::PHASES['initializing']['description'],
- 'total_items' => $options['total_items'] ?? 0,
- 'processed_items' => 0,
- 'current_item_type' => null,
- 'current_item_name' => null,
- 'percentage' => 0,
- 'start_time' => time(),
+ 'operation_id' => $operationId,
+ 'operation_type' => $operationType,
+ 'phase' => 'initializing',
+ 'phase_description' => self::PHASES['initializing']['description'],
+ 'total_items' => $options['total_items'] ?? 0,
+ 'processed_items' => 0,
+ 'current_item_type' => null,
+ 'current_item_name' => null,
+ 'percentage' => 0,
+ 'start_time' => time(),
'estimated_completion' => null,
- 'errors' => [],
- 'warnings' => [],
- 'statistics' => $options['statistics'] ?? []
+ 'errors' => [],
+ 'warnings' => [],
+ 'statistics' => $options['statistics'] ?? [],
];
$this->saveProgress();
-
- $this->logger->info('Started progress tracking', [
- 'operation_id' => $operationId,
- 'operation_type' => $operationType,
- 'total_items' => $this->progress['total_items']
- ]);
+
+ $this->logger->info(
+ 'Started progress tracking',
+ [
+ 'operation_id' => $operationId,
+ 'operation_type' => $operationType,
+ 'total_items' => $this->progress['total_items'],
+ ]
+ );
return $operationId;
- }
+ }//end startOperation()
/**
* Set the current phase of the operation
*
* @param string $phase Phase identifier
* @param array $data Additional phase data
- *
+ *
* @return void
*/
- public function setPhase(string $phase, array $data = []): void
+ public function setPhase(string $phase, array $data=[]): void
{
- if (!isset(self::PHASES[$phase])) {
+ if (isset(self::PHASES[$phase]) === false) {
$this->logger->warning('Unknown progress phase', ['phase' => $phase]);
return;
}
@@ -142,24 +145,27 @@ public function setPhase(string $phase, array $data = []): void
$this->progress['phase'] = $phase;
$this->progress['phase_description'] = self::PHASES[$phase]['description'];
- // Update total items if provided
- if (isset($data['total_items'])) {
+ // Update total items if provided.
+ if (isset($data['total_items']) === true) {
$this->progress['total_items'] = $data['total_items'];
}
- // Reset processed items for new phase if specified
- if (isset($data['reset_progress']) && $data['reset_progress']) {
+ // Reset processed items for new phase if specified.
+ if (isset($data['reset_progress']) === true && $data['reset_progress'] === true) {
$this->progress['processed_items'] = 0;
}
$this->updateProgress();
-
- $this->logger->debug('Progress phase updated', [
- 'operation_id' => $this->progress['operation_id'],
- 'phase' => $phase,
- 'total_items' => $this->progress['total_items']
- ]);
- }
+
+ $this->logger->debug(
+ 'Progress phase updated',
+ [
+ 'operation_id' => $this->progress['operation_id'],
+ 'phase' => $phase,
+ 'total_items' => $this->progress['total_items'],
+ ]
+ );
+ }//end setPhase()
/**
* Update progress within the current phase
@@ -167,10 +173,10 @@ public function setPhase(string $phase, array $data = []): void
* @param int $processedItems Number of items processed
* @param string $currentItem Name of current item being processed
* @param string $itemType Type of current item
- *
+ *
* @return void
*/
- public function updateProgress(int $processedItems = null, string $currentItem = null, string $itemType = null): void
+ public function updateProgress(int $processedItems=null, string $currentItem=null, string $itemType=null): void
{
if ($processedItems !== null) {
$this->progress['processed_items'] = $processedItems;
@@ -184,137 +190,151 @@ public function updateProgress(int $processedItems = null, string $currentItem =
$this->progress['current_item_type'] = $itemType;
}
- // Calculate overall percentage based on phase weights and current progress
+ // Calculate overall percentage based on phase weights and current progress.
$this->progress['percentage'] = $this->calculateOverallPercentage();
-
- // Calculate estimated completion time
+
+ // Calculate estimated completion time.
$this->progress['estimated_completion'] = $this->calculateEstimatedCompletion();
$this->saveProgress();
- }
+ }//end updateProgress()
/**
* Increment the processed items counter by one
*
* @param string $currentItem Name of current item being processed
* @param string $itemType Type of current item
- *
+ *
* @return void
*/
- public function incrementProgress(string $currentItem = null, string $itemType = null): void
+ public function incrementProgress(string $currentItem=null, string $itemType=null): void
{
$this->updateProgress(
- $this->progress['processed_items'] + 1,
- $currentItem,
- $itemType
+ processedItems: $this->progress['processed_items'] + 1,
+ currentItem: $currentItem,
+ itemType: $itemType
);
- }
+ }//end incrementProgress()
/**
* Add an error to the progress tracking
*
* @param string $message Error message
* @param array $context Error context
- *
+ *
* @return void
*/
- public function addError(string $message, array $context = []): void
+ public function addError(string $message, array $context=[]): void
{
$this->progress['errors'][] = [
- 'message' => $message,
- 'context' => $context,
- 'timestamp' => time()
+ 'message' => $message,
+ 'context' => $context,
+ 'timestamp' => time(),
];
$this->saveProgress();
-
- $this->logger->error('Progress tracking error', [
- 'operation_id' => $this->progress['operation_id'],
- 'message' => $message,
- 'context' => $context
- ]);
- }
+
+ $this->logger->error(
+ 'Progress tracking error',
+ [
+ 'operation_id' => $this->progress['operation_id'],
+ 'message' => $message,
+ 'context' => $context,
+ ]
+ );
+ }//end addError()
/**
* Add a warning to the progress tracking
*
* @param string $message Warning message
* @param array $context Warning context
- *
+ *
* @return void
*/
- public function addWarning(string $message, array $context = []): void
+ public function addWarning(string $message, array $context=[]): void
{
$this->progress['warnings'][] = [
- 'message' => $message,
- 'context' => $context,
- 'timestamp' => time()
+ 'message' => $message,
+ 'context' => $context,
+ 'timestamp' => time(),
];
$this->saveProgress();
- }
+ }//end addWarning()
/**
* Update operation statistics
*
* @param array $statistics Statistics to merge
- *
+ *
* @return void
*/
public function updateStatistics(array $statistics): void
{
$this->progress['statistics'] = array_merge($this->progress['statistics'], $statistics);
$this->saveProgress();
- }
+ }//end updateStatistics()
/**
* Complete the operation
*
* @param array $finalStatistics Final operation statistics
- *
+ *
* @return void
*/
- public function completeOperation(array $finalStatistics = []): void
+ public function completeOperation(array $finalStatistics=[]): void
{
$this->progress['phase'] = 'completed';
- $this->progress['phase_description'] = self::PHASES['completed']['description'];
- $this->progress['percentage'] = 100;
- $this->progress['processed_items'] = $this->progress['total_items'];
+ $this->progress['phase_description'] = self::PHASES['completed']['description'];
+ $this->progress['percentage'] = 100;
+ $this->progress['processed_items'] = $this->progress['total_items'];
$this->progress['estimated_completion'] = time();
-
- if (!empty($finalStatistics)) {
+
+ if (empty($finalStatistics) === false) {
$this->progress['statistics'] = array_merge($this->progress['statistics'], $finalStatistics);
}
$this->saveProgress();
-
- $this->logger->info('Operation completed', [
- 'operation_id' => $this->progress['operation_id'],
- 'duration' => time() - $this->progress['start_time'],
- 'total_items' => $this->progress['total_items'],
- 'errors' => count($this->progress['errors']),
- 'warnings' => count($this->progress['warnings'])
- ]);
- }
+
+ $this->logger->info(
+ 'Operation completed',
+ [
+ 'operation_id' => $this->progress['operation_id'],
+ 'duration' => time() - $this->progress['start_time'],
+ 'total_items' => $this->progress['total_items'],
+ 'errors' => count($this->progress['errors']),
+ 'warnings' => count($this->progress['warnings']),
+ ]
+ );
+ }//end completeOperation()
/**
* Get current progress state
*
* @param string $operationId Operation ID to get progress for
- *
+ *
* @return array|null Progress data or null if not found
*/
- public function getProgress(string $operationId = null): ?array
+ public function getProgress(string $operationId=null): ?array
{
- if ($operationId && $operationId !== $this->progress['operation_id']) {
- // Load progress from session for different operation
- $sessionKey = 'progress_' . $operationId;
+ if ($operationId !== null && $operationId !== $this->progress['operation_id']) {
+ // Load progress from session for different operation.
+ $sessionKey = 'progress_'.$operationId;
$storedProgress = $this->session->get($sessionKey);
- return $storedProgress ?: null;
+ if ($storedProgress !== null && $storedProgress !== false) {
+ return $storedProgress;
+ }
+
+ return null;
}
- return $this->progress['operation_id'] ? $this->progress : null;
- }
+ if ($this->progress['operation_id'] !== null) {
+ return $this->progress;
+ }
+
+ return null;
+ }//end getProgress()
/**
* Calculate overall percentage based on phase weights and current progress
@@ -323,36 +343,41 @@ public function getProgress(string $operationId = null): ?array
*/
private function calculateOverallPercentage(): int
{
- $totalWeight = array_sum(array_column(self::PHASES, 'weight'));
- $completedWeight = 0;
- $currentPhaseWeight = 0;
+ $totalWeight = array_sum(array_column(self::PHASES, 'weight'));
+ $completedWeight = 0;
+ $currentPhaseWeight = 0;
$currentPhaseProgress = 0;
- $phases = array_keys(self::PHASES);
+ $phases = array_keys(self::PHASES);
$currentPhaseIndex = array_search($this->progress['phase'], $phases);
- // Add weight of all completed phases
+ // Add weight of all completed phases.
for ($i = 0; $i < $currentPhaseIndex; $i++) {
$completedWeight += self::PHASES[$phases[$i]]['weight'];
}
- // Calculate progress within current phase
+ // Calculate progress within current phase.
if ($currentPhaseIndex !== false) {
$currentPhaseWeight = self::PHASES[$this->progress['phase']]['weight'];
-
+
if ($this->progress['total_items'] > 0) {
- $currentPhaseProgress = ($this->progress['processed_items'] / $this->progress['total_items']) * $currentPhaseWeight;
+ $itemRatio = $this->progress['processed_items'] / $this->progress['total_items'];
+ $currentPhaseProgress = $itemRatio * $currentPhaseWeight;
} else {
- // If no items to process, consider phase as complete
+ // If no items to process, consider phase as complete.
$currentPhaseProgress = $currentPhaseWeight;
}
}
$overallProgress = $completedWeight + $currentPhaseProgress;
- $percentage = $totalWeight > 0 ? intval(($overallProgress / $totalWeight) * 100) : 0;
+ if ($totalWeight > 0) {
+ $percentage = intval(($overallProgress / $totalWeight) * 100);
+ } else {
+ $percentage = 0;
+ }
return min(100, max(0, $percentage));
- }
+ }//end calculateOverallPercentage()
/**
* Calculate estimated completion time
@@ -365,11 +390,11 @@ private function calculateEstimatedCompletion(): ?int
return null;
}
- $elapsed = time() - $this->progress['start_time'];
+ $elapsed = time() - $this->progress['start_time'];
$estimatedTotal = ($elapsed / $this->progress['percentage']) * 100;
-
+
return $this->progress['start_time'] + intval($estimatedTotal);
- }
+ }//end calculateEstimatedCompletion()
/**
* Save progress to session
@@ -378,23 +403,23 @@ private function calculateEstimatedCompletion(): ?int
*/
private function saveProgress(): void
{
- if ($this->progress['operation_id']) {
- $sessionKey = 'progress_' . $this->progress['operation_id'];
+ if ($this->progress['operation_id'] !== null) {
+ $sessionKey = 'progress_'.$this->progress['operation_id'];
$this->session->set($sessionKey, $this->progress);
}
- }
+ }//end saveProgress()
/**
* Clean up old progress entries from session
*
* @param int $maxAge Maximum age in seconds (default: 1 hour)
- *
+ *
* @return void
*/
- public function cleanupOldProgress(int $maxAge = 3600): void
+ public function cleanupOldProgress(int $maxAge=3600): void
{
- // Note: This would need to iterate through session keys to find and clean old progress entries
- // Implementation depends on session storage capabilities
+ // Note: This would need to iterate through session keys to find and clean old progress entries.
+ // Implementation depends on session storage capabilities.
$this->logger->debug('Progress cleanup requested', ['max_age' => $maxAge]);
- }
-}
\ No newline at end of file
+ }//end cleanupOldProgress()
+}//end class
diff --git a/lib/Service/SettingsService.php b/lib/Service/SettingsService.php
index 91381b0c..fc18f71b 100644
--- a/lib/Service/SettingsService.php
+++ b/lib/Service/SettingsService.php
@@ -42,12 +42,13 @@
*/
class SettingsService
{
+
/**
* The application name for identification and configuration purposes
*
* @var string The name of the app
*/
- private string $_appName;
+ private string $appName;
/**
* Cache for schema IDs by object type to avoid repeated database queries
@@ -80,11 +81,11 @@ class SettingsService
/**
* SettingsService constructor
*
- * @param IAppConfig $config App configuration interface
- * @param IRequest $request Request interface
- * @param ContainerInterface $container Container for dependency injection
- * @param IAppManager $appManager App manager interface
- * @param LoggerInterface $logger Logger interface
+ * @param IAppConfig $config App configuration interface
+ * @param IRequest $request Request interface
+ * @param ContainerInterface $container Container for dependency injection
+ * @param IAppManager $appManager App manager interface
+ * @param LoggerInterface $logger Logger interface
*/
public function __construct(
private readonly IAppConfig $config,
@@ -94,7 +95,7 @@ public function __construct(
private readonly LoggerInterface $logger
) {
$this->_appName = 'softwarecatalog';
- }
+ }//end __construct()
/**
* Checks if OpenRegister is installed and meets version requirements
@@ -103,9 +104,9 @@ public function __construct(
*
* @return bool True if OpenRegister is installed and meets version requirements
*/
- public function isOpenRegisterInstalled(?string $minVersion = self::MIN_OPENREGISTER_VERSION): bool
+ public function isOpenRegisterInstalled(?string $minVersion=self::MIN_OPENREGISTER_VERSION): bool
{
- if (!$this->appManager->isInstalled(self::OPENREGISTER_APP_ID)) {
+ if ($this->appManager->isInstalled(appId: self::OPENREGISTER_APP_ID) === false) {
return false;
}
@@ -115,7 +116,7 @@ public function isOpenRegisterInstalled(?string $minVersion = self::MIN_OPENREGI
$currentVersion = $this->appManager->getAppVersion(self::OPENREGISTER_APP_ID);
return version_compare($currentVersion, $minVersion, '>=');
- }
+ }//end isOpenRegisterInstalled()
/**
* Checks if OpenRegister is enabled
@@ -125,7 +126,7 @@ public function isOpenRegisterInstalled(?string $minVersion = self::MIN_OPENREGI
public function isOpenRegisterEnabled(): bool
{
return $this->appManager->isEnabledForUser(self::OPENREGISTER_APP_ID);
- }
+ }//end isOpenRegisterEnabled()
/**
* Attempts to retrieve the OpenRegister service from the container
@@ -136,12 +137,12 @@ public function isOpenRegisterEnabled(): bool
*/
public function getObjectService(): ?\OCA\OpenRegister\Service\ObjectService
{
- if (in_array('openregister', $this->appManager->getInstalledApps())) {
+ if (in_array(needle: 'openregister', haystack: $this->appManager->getInstalledApps()) === true) {
return $this->container->get('OCA\OpenRegister\Service\ObjectService');
}
throw new \RuntimeException('OpenRegister service is not available.');
- }
+ }//end getObjectService()
/**
* Get the OpenRegister RegisterService.
@@ -150,12 +151,12 @@ public function getObjectService(): ?\OCA\OpenRegister\Service\ObjectService
*/
public function getRegisterService(): ?\OCA\OpenRegister\Service\RegisterService
{
- if (in_array('openregister', $this->appManager->getInstalledApps())) {
+ if (in_array(needle: 'openregister', haystack: $this->appManager->getInstalledApps()) === true) {
return $this->container->get('OCA\OpenRegister\Service\RegisterService');
}
throw new \RuntimeException('OpenRegister RegisterService is not available.');
- }
+ }//end getRegisterService()
/**
* Attempts to retrieve the Configuration service from the container
@@ -166,12 +167,12 @@ public function getRegisterService(): ?\OCA\OpenRegister\Service\RegisterService
*/
public function getConfigurationService(): ?\OCA\OpenRegister\Service\ConfigurationService
{
- if (in_array('openregister', $this->appManager->getInstalledApps())) {
+ if (in_array(needle: 'openregister', haystack: $this->appManager->getInstalledApps()) === true) {
return $this->container->get('OCA\OpenRegister\Service\ConfigurationService');
}
throw new \RuntimeException('Configuration service is not available.');
- }
+ }//end getConfigurationService()
/**
* Retrieve the current settings
@@ -182,33 +183,49 @@ public function getConfigurationService(): ?\OCA\OpenRegister\Service\Configurat
*/
public function getSettings(): array
{
- // Initialize the data array
+ // Initialize the data array.
$data = [];
- // Define the register-specific configuration
+ // Define the register-specific configuration.
$data['registerTypes'] = [
- 'amef' => [
- 'name' => 'AMEF',
+ 'amef' => [
+ 'name' => 'AMEF',
'description' => 'AMEF register for architectural elements',
- 'objectTypes' => ['organization', 'element', 'relation', 'view', 'model', 'property', 'property-definition'] // Complete AMEF object types
+ 'objectTypes' => ['organization', 'element', 'relation', 'view', 'model', 'property', 'property-definition'],
+ // Complete AMEF object types.
],
'voorzieningen' => [
- 'name' => 'Voorzieningen',
+ 'name' => 'Voorzieningen',
'description' => 'Voorzieningen register for software catalog services',
- 'objectTypes' => ['sector', 'suite', 'dienst', 'kwetsbaarheid', 'contactpersoon', 'organisatie', 'gebruik', 'contract', 'koppeling', 'beoordeeling', 'module', 'compliancy', 'moduleVersie'] // All voorzieningen schemas
- ]
+ // All voorzieningen schemas.
+ 'objectTypes' => [
+ 'sector',
+ 'suite',
+ 'dienst',
+ 'kwetsbaarheid',
+ 'contactpersoon',
+ 'organisatie',
+ 'gebruik',
+ 'contract',
+ 'koppeling',
+ 'beoordeeling',
+ 'module',
+ 'compliancy',
+ 'moduleVersie',
+ ],
+ ],
];
- // Deprecated: For backward compatibility only - use registerTypes instead
+ // Deprecated: For backward compatibility only - use registerTypes instead.
$data['objectTypes'] = [
'organization',
'contact',
];
- $data['openRegisters'] = false;
+ $data['openRegisters'] = false;
$data['availableRegisters'] = [];
- // Check if the OpenRegister service is available
+ // Check if the OpenRegister service is available.
try {
$openRegisters = $this->getObjectService();
if ($openRegisters !== null) {
@@ -217,31 +234,36 @@ public function getSettings(): array
// Add additional error handling for OpenRegister internal errors.
try {
$registerService = $this->getRegisterService();
- $rawRegisters = $registerService->findAll();
-
- // Convert Register entities to arrays first
- $rawRegisters = array_map(function($register) {
- return is_object($register) && method_exists($register, 'jsonSerialize')
- ? $register->jsonSerialize()
- : (array)$register;
- }, $rawRegisters);
+ $rawRegisters = $registerService->findAll();
+
+ // Convert Register entities to arrays first.
+ $rawRegisters = array_map(
+ function ($register) {
+ if (is_object($register) === true && method_exists($register, 'jsonSerialize') === true) {
+ return $register->jsonSerialize();
+ } else {
+ return (array) $register;
+ }
+ },
+ $rawRegisters
+ );
- // Collect all schema IDs that need to be fetched (batch approach)
+ // Collect all schema IDs that need to be fetched (batch approach).
$allSchemaIds = [];
foreach ($rawRegisters as $register) {
foreach (($register['schemas'] ?? []) as $schema) {
- if (is_int($schema) || is_numeric($schema)) {
- $allSchemaIds[] = (int)$schema;
+ if (is_int($schema) === true || is_numeric($schema) === true) {
+ $allSchemaIds[] = (int) $schema;
}
}
}
- // Batch fetch all schemas in one query if we have IDs
+ // Batch fetch all schemas in one query if we have IDs.
$schemaMap = [];
- if (!empty($allSchemaIds)) {
+ if (empty($allSchemaIds) === false) {
try {
$schemaMapper = $this->container->get(\OCA\OpenRegister\Db\SchemaMapper::class);
- $schemas = $schemaMapper->findMultipleOptimized(array_unique($allSchemaIds));
+ $schemas = $schemaMapper->findMultipleOptimized(array_unique($allSchemaIds));
foreach ($schemas as $schema) {
$schemaMap[$schema->getId()] = $schema->jsonSerialize();
}
@@ -250,110 +272,126 @@ public function getSettings(): array
}
}
- // Map schema details back to registers
- $rawRegisters = array_map(function($register) use ($schemaMap) {
- if (isset($register['schemas']) && is_array($register['schemas'])) {
- $schemaDetails = [];
- foreach ($register['schemas'] as $schema) {
- if (is_array($schema) && isset($schema['slug'])) {
- // Schema is already a full object
- $schemaDetails[] = $schema;
- } elseif (is_int($schema) || is_numeric($schema)) {
- // Schema is an ID - get from pre-fetched map
- if (isset($schemaMap[(int)$schema])) {
- $schemaDetails[] = $schemaMap[(int)$schema];
+ // Map schema details back to registers.
+ $rawRegisters = array_map(
+ function ($register) use ($schemaMap) {
+ if (isset($register['schemas']) === true && is_array($register['schemas']) === true) {
+ $schemaDetails = [];
+ foreach ($register['schemas'] as $schema) {
+ if (is_array($schema) === true && isset($schema['slug']) === true) {
+ // Schema is already a full object.
+ $schemaDetails[] = $schema;
+ } else if (is_int($schema) === true || is_numeric($schema) === true) {
+ // Schema is an ID - get from pre-fetched map.
+ if (isset($schemaMap[(int) $schema]) === true) {
+ $schemaDetails[] = $schemaMap[(int) $schema];
+ }
+ }
}
+
+ $register['schemas'] = $schemaDetails;
}
- }
- $register['schemas'] = $schemaDetails;
- }
- return $register;
- }, $rawRegisters);
-
- // Filter schemas to remove properties field for cleaner response
- $data['availableRegisters'] = array_map(function($register) {
- if (isset($register['schemas']) && is_array($register['schemas'])) {
- $register['schemas'] = array_map(function($schema) {
- // Keep only essential schema fields, remove properties
- if (is_array($schema)) {
- return array_filter($schema, function($key) {
- return !in_array($key, ['properties']);
- }, ARRAY_FILTER_USE_KEY);
+
+ return $register;
+ },
+ $rawRegisters
+ );
+
+ // Filter schemas to remove properties field for cleaner response.
+ $data['availableRegisters'] = array_map(
+ function ($register) {
+ if (isset($register['schemas']) === true && is_array($register['schemas']) === true) {
+ $register['schemas'] = array_map(
+ function ($schema) {
+ // Keep only essential schema fields, remove properties.
+ if (is_array($schema) === true) {
+ return array_filter(
+ $schema,
+ function ($key) {
+ return in_array($key, ['properties']) === false;
+ },
+ ARRAY_FILTER_USE_KEY
+ );
+ }
+
+ return $schema;
+ },
+ $register['schemas']
+ );
}
- return $schema;
- }, $register['schemas']);
- }
- return $register;
- }, $rawRegisters);
+
+ return $register;
+ },
+ $rawRegisters
+ );
} catch (\TypeError $e) {
- // Handle OpenRegister internal errors (e.g. RegisterMapper parameter issues)
+ // Handle OpenRegister internal errors (e.g. RegisterMapper parameter issues).
$this->logger->warning(
'OpenRegister internal error - using empty registers list',
[
'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine()
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
]
);
$data['availableRegisters'] = [];
} catch (\Exception $e) {
- // Handle any other OpenRegister errors
+ // Handle any other OpenRegister errors.
$this->logger->warning(
'OpenRegister getRegisters() failed - using empty registers list',
[
'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine()
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
]
);
$data['availableRegisters'] = [];
- }
- }
+ }//end try
+ }//end if
} catch (\RuntimeException $e) {
- // Service not available, continue with default values
+ // Service not available, continue with default values.
$this->logger->info(
'OpenRegister service not available',
[
- 'exception' => $e->getMessage()
+ 'exception' => $e->getMessage(),
]
);
- }
+ }//end try
- // Build defaults array dynamically based on register types and their object types
+ // Build defaults array dynamically based on register types and their object types.
$defaults = [];
foreach ($data['registerTypes'] as $registerType => $config) {
foreach ($config['objectTypes'] as $objectType) {
- // Always use openregister as source
- $defaults["{$registerType}_{$objectType}_source"] = 'openregister';
- $defaults["{$registerType}_{$objectType}_schema"] = '';
+ // Always use openregister as source.
+ $defaults["{$registerType}_{$objectType}_source"] = 'openregister';
+ $defaults["{$registerType}_{$objectType}_schema"] = '';
$defaults["{$registerType}_{$objectType}_register"] = '';
}
}
- // Also maintain backward compatibility for the old structure
+ // Also maintain backward compatibility for the old structure.
foreach ($data['objectTypes'] as $type) {
- $defaults["{$type}_source"] = 'openregister';
- $defaults["{$type}_schema"] = '';
+ $defaults["{$type}_source"] = 'openregister';
+ $defaults["{$type}_schema"] = '';
$defaults["{$type}_register"] = '';
}
- // Note: Old individual config keys are no longer used
- // They are maintained only for backward compatibility during migration
-
- // Get the current values from the configuration
+ // Note: Old individual config keys are no longer used.
+ // They are maintained only for backward compatibility during migration.
+ // Get the current values from the configuration.
try {
foreach ($defaults as $key => $defaultValue) {
$data['configuration'][$key] = $this->config->getValueString($this->_appName, $key, $defaultValue);
}
- // Add catalog location
+ // Add catalog location.
$data['catalogLocation'] = $this->getCatalogLocation();
return $data;
} catch (\Exception $e) {
- throw new \RuntimeException('Failed to retrieve settings: ' . $e->getMessage());
+ throw new \RuntimeException('Failed to retrieve settings: '.$e->getMessage());
}
- }
+ }//end getSettings()
/**
* Update the settings configuration
@@ -367,41 +405,48 @@ public function getSettings(): array
public function updateSettings(array $data): array
{
try {
- // Update each setting in the configuration
+ // Update each setting in the configuration.
foreach ($data as $key => $value) {
- // Skip empty keys
- if (empty($key)) {
- $this->logger->warning('Skipping empty key in updateSettings', [
- 'value' => $value
- ]);
+ // Skip empty keys.
+ if (empty($key) === true) {
+ $this->logger->warning(
+ 'Skipping empty key in updateSettings',
+ [
+ 'value' => $value,
+ ]
+ );
continue;
}
- // Handle arrays and objects by converting to JSON
- if (is_array($value) || is_object($value)) {
+ // Handle arrays and objects by converting to JSON.
+ if (is_array($value) === true || is_object($value) === true) {
$stringValue = json_encode($value);
} else {
- // Ensure value is converted to string as required by setValueString
- $stringValue = is_string($value) ? $value : (string) $value;
+ // Ensure value is converted to string as required by setValueString.
+ if (is_string($value) === true) {
+ $stringValue = $value;
+ } else {
+ $stringValue = (string) $value;
+ }
}
$this->config->setValueString($this->_appName, $key, $stringValue);
- // Retrieve the updated value to confirm the change
+ // Retrieve the updated value to confirm the change.
$data[$key] = $this->config->getValueString($this->_appName, $key);
- }
+ }//end foreach
$this->logger->info(
'Settings updated successfully',
[
- 'updatedKeys' => array_keys($data)
+ 'updatedKeys' => array_keys($data),
]
);
return $data;
} catch (\Exception $e) {
- throw new \RuntimeException('Failed to update settings: ' . $e->getMessage());
- }
- }
+ throw new \RuntimeException('Failed to update settings: '.$e->getMessage());
+ }//end try
+ }//end updateSettings()
/**
* Attempts to auto-configure registers and schemas
@@ -410,19 +455,21 @@ public function updateSettings(array $data): array
*
* @throws \RuntimeException If auto-configuration fails
*/
+
/**
* Auto-configure settings based on available registers and schemas
* This method now uses the consolidated auto-configuration logic
*
- * @param bool $force Whether to force reload regardless of version
- * @return array The auto-configuration results
+ * @param bool $force Whether to force reload regardless of version.
+ *
+ * @return array The auto-configuration results.
*
* @throws \RuntimeException If auto-configuration fails
*/
- public function autoConfigure(bool $force = false): array
+ public function autoConfigure(bool $force=false): array
{
- return $this->performConsolidatedAutoConfiguration($force);
- }
+ return $this->performConsolidatedAutoConfiguration(force: $force);
+ }//end autoConfigure()
/**
* Auto-configures settings specifically after importing the softwarecatalogus_register_magic.json
@@ -437,79 +484,96 @@ public function autoConfigure(bool $force = false): array
public function autoConfigureAfterImport(): array
{
try {
- // Check if auto-configuration has already been completed
+ // Check if auto-configuration has already been completed.
$autoConfigCompleted = $this->config->getValueString($this->_appName, 'auto_config_completed', 'false') === 'true';
- if ($autoConfigCompleted) {
+ if (empty($autoConfigCompleted) === false) {
$this->logger->info('Auto-configuration already completed, skipping');
return [];
}
$this->logger->info('Starting comprehensive auto-configuration after import');
- // Step 1: Create required user groups
+ // Step 1: Create required user groups.
$this->logger->info('Creating required user groups');
$this->createRequiredUserGroups();
$this->logger->info('User groups created successfully');
- // Step 2: Configure Voorzieningen using the consolidated method
+ // Step 2: Configure Voorzieningen using the consolidated method.
$this->logger->info('Running voorzieningen auto-configuration');
$voorzieningenResult = $this->configureVoorzieningen();
- if (!$voorzieningenResult['success']) {
- $this->logger->warning('Voorzieningen auto-configuration failed', [
- 'message' => $voorzieningenResult['message'] ?? 'Unknown error'
- ]);
+ if ($voorzieningenResult['success'] === false) {
+ $this->logger->warning(
+ 'Voorzieningen auto-configuration failed',
+ [
+ 'message' => $voorzieningenResult['message'] ?? 'Unknown error',
+ ]
+ );
return [];
}
- $this->logger->info('Voorzieningen auto-configuration completed successfully', [
- 'configured' => $voorzieningenResult['configured'] ?? []
- ]);
+ $this->logger->info(
+ 'Voorzieningen auto-configuration completed successfully',
+ [
+ 'configured' => $voorzieningenResult['configured'] ?? [],
+ ]
+ );
- // Step 3: Configure AMEF using the consolidated method
+ // Step 3: Configure AMEF using the consolidated method.
$this->logger->info('Running AMEF auto-configuration');
$amefResult = $this->configureAmef();
- if (!$amefResult['success']) {
- $this->logger->info('AMEF auto-configuration not completed', [
- 'message' => $amefResult['message'] ?? 'No AMEF register found'
- ]);
+ if ($amefResult['success'] === false) {
+ $this->logger->info(
+ 'AMEF auto-configuration not completed',
+ [
+ 'message' => $amefResult['message'] ?? 'No AMEF register found',
+ ]
+ );
} else {
- $this->logger->info('AMEF auto-configuration completed successfully', [
- 'configured' => $amefResult['configured'] ?? []
- ]);
+ $this->logger->info(
+ 'AMEF auto-configuration completed successfully',
+ [
+ 'configured' => $amefResult['configured'] ?? [],
+ ]
+ );
}
- // Step 4: Configure OpenCatalogi app settings for pages/menus/themes
+ // Step 4: Configure OpenCatalogi app settings for pages/menus/themes.
$this->logger->info('Running OpenCatalogi auto-configuration');
$openCatalogiResult = $this->configureOpenCatalogi();
- if ($openCatalogiResult['success']) {
- $this->logger->info('OpenCatalogi auto-configuration completed successfully', [
- 'configured' => $openCatalogiResult['configured'] ?? []
- ]);
+ if ($openCatalogiResult['success'] === true) {
+ $this->logger->info(
+ 'OpenCatalogi auto-configuration completed successfully',
+ [
+ 'configured' => $openCatalogiResult['configured'] ?? [],
+ ]
+ );
} else {
- $this->logger->info('OpenCatalogi auto-configuration skipped', [
- 'message' => $openCatalogiResult['message'] ?? 'OpenCatalogi not installed or not needed'
- ]);
+ $this->logger->info(
+ 'OpenCatalogi auto-configuration skipped',
+ [
+ 'message' => $openCatalogiResult['message'] ?? 'OpenCatalogi not installed or not needed',
+ ]
+ );
}
- // Mark auto-configuration as completed
+ // Mark auto-configuration as completed.
$this->config->setValueString($this->_appName, 'auto_config_completed', 'true');
$this->logger->info('Comprehensive auto-configuration marked as completed');
- // Return the consolidated configuration result
+ // Return the consolidated configuration result.
return [
- 'voorzieningen' => $voorzieningenResult,
- 'amef' => $amefResult,
- 'opencatalogi' => $openCatalogiResult,
- 'user_groups_created' => true
+ 'voorzieningen' => $voorzieningenResult,
+ 'amef' => $amefResult,
+ 'opencatalogi' => $openCatalogiResult,
+ 'user_groups_created' => true,
];
-
} catch (\Exception $e) {
- throw new \RuntimeException('Failed to auto-configure after import: ' . $e->getMessage());
- }
- }
+ throw new \RuntimeException('Failed to auto-configure after import: '.$e->getMessage());
+ }//end try
+ }//end autoConfigureAfterImport()
/**
* Configure OpenCatalogi app settings for pages, menus, and themes
@@ -522,25 +586,25 @@ public function autoConfigureAfterImport(): array
public function configureOpenCatalogi(): array
{
$result = [
- 'success' => false,
- 'message' => '',
- 'configured' => []
+ 'success' => false,
+ 'message' => '',
+ 'configured' => [],
];
try {
- // Check if opencatalogi app is installed
- if (!in_array('opencatalogi', $this->appManager->getInstalledApps())) {
+ // Check if opencatalogi app is installed.
+ if (in_array('opencatalogi', $this->appManager->getInstalledApps()) === false) {
$result['message'] = 'OpenCatalogi app is not installed';
return $result;
}
- // Get OpenRegister services
- $schemaMapper = $this->container->get('OCA\OpenRegister\Db\SchemaMapper');
+ // Get OpenRegister services.
+ $schemaMapper = $this->container->get('OCA\OpenRegister\Db\SchemaMapper');
$registerMapper = $this->container->get('OCA\OpenRegister\Db\RegisterMapper');
- // Find the publication register
+ // Find the publication register.
$publicationRegister = null;
- $registers = $registerMapper->findAll();
+ $registers = $registerMapper->findAll();
foreach ($registers as $register) {
if ($register->getSlug() === 'publication') {
$publicationRegister = $register;
@@ -555,78 +619,80 @@ public function configureOpenCatalogi(): array
$registerId = (string) $publicationRegister->getId();
- // Find page, menu, and theme schemas that have data in magic mapper tables
- // We look for schemas by slug and check if they have associated data
- $schemas = $schemaMapper->findAll();
- $pageSchemaId = null;
- $menuSchemaId = null;
+ // Find page, menu, and theme schemas that have data in magic mapper tables.
+ // We look for schemas by slug and check if they have associated data.
+ $schemas = $schemaMapper->findAll();
+ $pageSchemaId = null;
+ $menuSchemaId = null;
$themeSchemaId = null;
foreach ($schemas as $schema) {
- $slug = $schema->getSlug();
+ $slug = $schema->getSlug();
$schemaId = $schema->getId();
- // Check if this schema has a magic mapper table with data for register 1
- $tableName = 'oc_openregister_table_' . $registerId . '_' . $schemaId;
+ // Check if this schema has a magic mapper table with data for register 1.
+ $tableName = 'oc_openregister_table_'.$registerId.'_'.$schemaId;
- // Try to find schemas that have actual data
+ // Try to find schemas that have actual data.
if ($slug === 'page' && $pageSchemaId === null) {
- if ($this->tableHasData($tableName)) {
+ if ($this->tableHasData(tableName: $tableName) === true) {
$pageSchemaId = (string) $schemaId;
}
- } elseif ($slug === 'menu' && $menuSchemaId === null) {
- if ($this->tableHasData($tableName)) {
+ } else if ($slug === 'menu' && $menuSchemaId === null) {
+ if ($this->tableHasData(tableName: $tableName) === true) {
$menuSchemaId = (string) $schemaId;
}
- } elseif ($slug === 'theme' && $themeSchemaId === null) {
- if ($this->tableHasData($tableName)) {
+ } else if ($slug === 'theme' && $themeSchemaId === null) {
+ if ($this->tableHasData(tableName: $tableName) === true) {
$themeSchemaId = (string) $schemaId;
}
}
- }
+ }//end foreach
- // Set the opencatalogi app configuration
+ // Set the opencatalogi app configuration.
$configured = [];
if ($pageSchemaId !== null) {
$this->config->setValueString('opencatalogi', 'page_schema', $pageSchemaId);
$this->config->setValueString('opencatalogi', 'page_register', $registerId);
- $configured['page_schema'] = $pageSchemaId;
+ $configured['page_schema'] = $pageSchemaId;
$configured['page_register'] = $registerId;
}
if ($menuSchemaId !== null) {
$this->config->setValueString('opencatalogi', 'menu_schema', $menuSchemaId);
$this->config->setValueString('opencatalogi', 'menu_register', $registerId);
- $configured['menu_schema'] = $menuSchemaId;
+ $configured['menu_schema'] = $menuSchemaId;
$configured['menu_register'] = $registerId;
}
if ($themeSchemaId !== null) {
$this->config->setValueString('opencatalogi', 'theme_schema', $themeSchemaId);
$this->config->setValueString('opencatalogi', 'theme_register', $registerId);
- $configured['theme_schema'] = $themeSchemaId;
+ $configured['theme_schema'] = $themeSchemaId;
$configured['theme_register'] = $registerId;
}
- if (!empty($configured)) {
- $result['success'] = true;
+ if (empty($configured) === false) {
+ $result['success'] = true;
$result['configured'] = $configured;
- $result['message'] = 'OpenCatalogi configured successfully';
+ $result['message'] = 'OpenCatalogi configured successfully';
$this->logger->info('OpenCatalogi configuration set', $configured);
} else {
$result['message'] = 'No page/menu/theme schemas with data found';
}
-
} catch (\Exception $e) {
- $result['message'] = 'Failed to configure OpenCatalogi: ' . $e->getMessage();
- $this->logger->error('OpenCatalogi configuration failed', [
- 'exception' => $e->getMessage()
- ]);
- }
+ $result['message'] = 'Failed to configure OpenCatalogi: '.$e->getMessage();
+ $this->logger->error(
+ 'OpenCatalogi configuration failed',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
+ }//end try
return $result;
- }
+ }//end configureOpenCatalogi()
/**
* Check if a database table exists and has data
@@ -639,15 +705,15 @@ private function tableHasData(string $tableName): bool
{
try {
$connection = $this->container->get('OCP\IDBConnection');
- $sql = "SELECT COUNT(*) as cnt FROM {$tableName} WHERE _deleted IS NULL LIMIT 1";
- $stmt = $connection->executeQuery($sql);
- $row = $stmt->fetch();
- return ($row && (int) $row['cnt'] > 0);
+ $sql = "SELECT COUNT(*) as cnt FROM {$tableName} WHERE _deleted IS NULL LIMIT 1";
+ $stmt = $connection->executeQuery($sql);
+ $row = $stmt->fetch();
+ return ($row !== false && (int) $row['cnt'] > 0);
} catch (\Exception $e) {
- // Table doesn't exist or other error
+ // Table doesn't exist or other error.
return false;
}
- }
+ }//end tableHasData()
/**
* Gets the configured schema ID for a specific object type
@@ -658,84 +724,95 @@ private function tableHasData(string $tableName): bool
*/
public function getSchemaIdForObjectType(string $objectType): ?int
{
- // Check cache first for performance optimization
- if (array_key_exists($objectType, $this->schemaIdCache)) {
+ // Check cache first for performance optimization.
+ if (array_key_exists($objectType, $this->schemaIdCache) === true) {
$cachedValue = $this->schemaIdCache[$objectType];
- $this->logger->debug("SettingsService: Schema ID retrieved from cache", [
- 'objectType' => $objectType,
- 'cachedValue' => $cachedValue,
- 'fromCache' => true
- ]);
+ $this->logger->debug(
+ "SettingsService: Schema ID retrieved from cache",
+ [
+ 'objectType' => $objectType,
+ 'cachedValue' => $cachedValue,
+ 'fromCache' => true,
+ ]
+ );
return $cachedValue;
}
$startTime = microtime(true);
- $result = null;
+ $result = null;
$voorzieningenConfig = $this->getVoorzieningenConfig();
- $this->logger->debug("SettingsService: Starting schema ID lookup (cache miss)", [
- 'objectType' => $objectType,
- 'timestamp' => date('Y-m-d H:i:s')
- ]);
+ $this->logger->debug(
+ "SettingsService: Starting schema ID lookup (cache miss)",
+ [
+ 'objectType' => $objectType,
+ 'timestamp' => date('Y-m-d H:i:s'),
+ ]
+ );
- // First try register-specific configuration
- // Check for AMEF register specific schemas from JSON config
+ // First try register-specific configuration.
+ // Check for AMEF register specific schemas from JSON config.
$amefConfig = $this->config->getValueString($this->_appName, 'amef_config', '{}');
- if (!empty($amefConfig) && $amefConfig !== '{}') {
+ if (empty($amefConfig) === false && $amefConfig !== '{}') {
$decodedAmefConfig = json_decode($amefConfig, true);
- if (is_array($decodedAmefConfig)) {
- // Map object types to their corresponding AMEF config keys
+ if (is_array($decodedAmefConfig) === true) {
+ // Map object types to their corresponding AMEF config keys.
$amefKeyMap = [
- 'model' => 'model_schema',
- 'element' => 'element_schema',
- 'relationship' => 'relation_schema', // Note: relation vs relationship
- 'view' => 'view_schema',
- 'property_definition' => 'property_definition_schema', // Property definitions are root-level AMEF objects
- 'organization' => 'organization_schema'
- // NOTE: 'property' mapping removed - properties are never root-level AMEF objects, only nested within other elements
+ 'model' => 'model_schema',
+ 'element' => 'element_schema',
+ 'relationship' => 'relation_schema',
+ // Note: relation vs relationship.
+ 'view' => 'view_schema',
+ 'property_definition' => 'property_definition_schema',
+ // Property definitions are root-level AMEF objects.
+ 'organization' => 'organization_schema',
+ // NOTE: 'property' mapping removed - properties are never root-level AMEF objects, only nested within other elements.
];
$amefKey = $amefKeyMap[$objectType] ?? null;
- if ($amefKey && isset($decodedAmefConfig[$amefKey])) {
+ if ($amefKey !== false && isset($decodedAmefConfig[$amefKey]) === true) {
$schemaId = $decodedAmefConfig[$amefKey];
- if (!empty($schemaId)) {
+ if (empty($schemaId) === false) {
$result = (int) $schemaId;
- $this->logger->debug("SettingsService: Found schema ID in AMEF JSON config", [
- 'objectType' => $objectType,
- 'amefKey' => $amefKey,
- 'schemaId' => $result
- ]);
+ $this->logger->debug(
+ "SettingsService: Found schema ID in AMEF JSON config",
+ [
+ 'objectType' => $objectType,
+ 'amefKey' => $amefKey,
+ 'schemaId' => $result,
+ ]
+ );
}
}
- }
- }
+ }//end if
+ }//end if
$voorzieningenKeyMap = [
- 'module' => 'module_schema',
- 'compliancy' => 'compliancy_schema',
+ 'module' => 'module_schema',
+ 'compliancy' => 'compliancy_schema',
'moduleVersie' => 'moduleVersie_schema',
];
- // Only check voorzieningen config if object type exists in the key map
- if ($result === null && isset($voorzieningenKeyMap[$objectType])) {
+ // Only check voorzieningen config if object type exists in the key map.
+ if ($result === null && isset($voorzieningenKeyMap[$objectType]) === true) {
$voorzieningenKey = $voorzieningenKeyMap[$objectType];
- if (isset($voorzieningenConfig[$voorzieningenKey]) && $voorzieningenConfig[$voorzieningenKey] !== null) {
+ if (isset($voorzieningenConfig[$voorzieningenKey]) === true && $voorzieningenConfig[$voorzieningenKey] !== null) {
$result = (int) $voorzieningenConfig[$voorzieningenKey];
}
}
- // Check for AMEF register specific schemas (legacy individual keys)
+ // Check for AMEF register specific schemas (legacy individual keys).
if ($result === null && $objectType === 'organization') {
$schemaId = $this->config->getValueString($this->_appName, 'amef_organization_schema', '');
- if (!empty($schemaId)) {
+ if (empty($schemaId) === false) {
$result = (int) $schemaId;
} else {
- // Also check voorzieningen register for organization/organisatie
+ // Also check voorzieningen register for organization/organisatie.
$schemaId = $voorzieningenConfig['organisatie_schema'];
- if (!empty($schemaId)) {
+ if (empty($schemaId) === false) {
$result = (int) $schemaId;
}
}
@@ -743,48 +820,54 @@ public function getSchemaIdForObjectType(string $objectType): ?int
if ($objectType === 'organisatie' && $result === null) {
$schemaId = $voorzieningenConfig['organisatie_schema'];
- if (!empty($schemaId)) {
+ if (empty($schemaId) === false) {
$result = (int) $schemaId;
}
}
if ($objectType === 'contactpersoon' && $result === null) {
$schemaId = $voorzieningenConfig['contactpersoon_schema'];
- if (!empty($schemaId)) {
+ if (empty($schemaId) === false) {
$result = (int) $schemaId;
}
}
- // Fall back to generic configuration for backward compatibility
+ // Fall back to generic configuration for backward compatibility.
if ($result === null) {
$schemaId = $this->config->getValueString($this->_appName, "{$objectType}_schema", '');
- if (!empty($schemaId)) {
+ if (empty($schemaId) === false) {
$result = (int) $schemaId;
}
}
- // Cache the result (even if null) to avoid repeated lookups
+ // Cache the result (even if null) to avoid repeated lookups.
$this->schemaIdCache[$objectType] = $result;
$lookupTime = round((microtime(true) - $startTime) * 1000, 2);
if ($result !== null) {
- $this->logger->info("SettingsService: Found schema ID and cached result", [
- 'objectType' => $objectType,
- 'schemaId' => $result,
- 'lookupTime' => $lookupTime . 'ms',
- 'fromCache' => false
- ]);
+ $this->logger->info(
+ "SettingsService: Found schema ID and cached result",
+ [
+ 'objectType' => $objectType,
+ 'schemaId' => $result,
+ 'lookupTime' => $lookupTime.'ms',
+ 'fromCache' => false,
+ ]
+ );
} else {
- $this->logger->debug("SettingsService: No schema ID found, cached null result", [
- 'objectType' => $objectType,
- 'lookupTime' => $lookupTime . 'ms',
- 'fromCache' => false
- ]);
+ $this->logger->debug(
+ "SettingsService: No schema ID found, cached null result",
+ [
+ 'objectType' => $objectType,
+ 'lookupTime' => $lookupTime.'ms',
+ 'fromCache' => false,
+ ]
+ );
}
return $result;
- }
+ }//end getSchemaIdForObjectType()
/**
* Gets the configured register ID for a specific object type
@@ -795,52 +878,62 @@ public function getSchemaIdForObjectType(string $objectType): ?int
*/
public function getRegisterIdForObjectType(string $objectType): ?int
{
- // Check cache first for performance optimization
- if (array_key_exists($objectType, $this->registerIdCache)) {
+ // Check cache first for performance optimization.
+ if (array_key_exists($objectType, $this->registerIdCache) === true) {
$cachedValue = $this->registerIdCache[$objectType];
- $this->logger->debug("SettingsService: Register ID retrieved from cache", [
- 'objectType' => $objectType,
- 'cachedValue' => $cachedValue,
- 'fromCache' => true
- ]);
+ $this->logger->debug(
+ "SettingsService: Register ID retrieved from cache",
+ [
+ 'objectType' => $objectType,
+ 'cachedValue' => $cachedValue,
+ 'fromCache' => true,
+ ]
+ );
return $cachedValue;
}
$result = null;
- // Check AMEF register for organization
+ // Check AMEF register for organization.
if ($objectType === 'organization') {
$amefConfig = $this->getAmefConfig();
- if (isset($amefConfig['register']) && !empty($amefConfig['register'])) {
+ if (isset($amefConfig['register']) === true && empty($amefConfig['register']) === false) {
$result = (int) $amefConfig['register'];
}
}
- // Check Voorzieningen register for organisatie/organization and contactpersoon/contact
- if ($result === null && in_array($objectType, ['organisatie', 'organization', 'contactpersoon', 'contact'], true)) {
+ // Check Voorzieningen register for organisatie/organization and contactpersoon/contact.
+ if ($result === null && in_array($objectType, ['organisatie', 'organization', 'contactpersoon', 'contact'], true) === true) {
$voorzieningenConfig = $this->getVoorzieningenConfig();
- if (isset($voorzieningenConfig['register']) && !empty($voorzieningenConfig['register'])) {
+ if (isset($voorzieningenConfig['register']) === true && empty($voorzieningenConfig['register']) === false) {
$result = (int) $voorzieningenConfig['register'];
}
}
- // Fallback to legacy per-object-type register config
+ // Fallback to legacy per-object-type register config.
if ($result === null) {
$registerId = $this->config->getValueString($this->_appName, "{$objectType}_register", '');
- $result = $registerId ? (int) $registerId : null;
+ if (empty($registerId) === false) {
+ $result = (int) $registerId;
+ } else {
+ $result = null;
+ }
}
- // Cache the result (even if null) to avoid repeated lookups
+ // Cache the result (even if null) to avoid repeated lookups.
$this->registerIdCache[$objectType] = $result;
- $this->logger->debug("SettingsService: Register ID looked up and cached", [
- 'objectType' => $objectType,
- 'result' => $result,
- 'fromCache' => false
- ]);
+ $this->logger->debug(
+ "SettingsService: Register ID looked up and cached",
+ [
+ 'objectType' => $objectType,
+ 'result' => $result,
+ 'fromCache' => false,
+ ]
+ );
return $result;
- }
+ }//end getRegisterIdForObjectType()
/**
* Clear cached schema and register IDs
@@ -852,16 +945,19 @@ public function getRegisterIdForObjectType(string $objectType): ?int
*/
public function clearConfigurationCache(): void
{
- $this->logger->debug("SettingsService: Clearing configuration cache", [
- 'cached_schema_ids' => count($this->schemaIdCache),
- 'cached_register_ids' => count($this->registerIdCache)
- ]);
+ $this->logger->debug(
+ "SettingsService: Clearing configuration cache",
+ [
+ 'cached_schema_ids' => count($this->schemaIdCache),
+ 'cached_register_ids' => count($this->registerIdCache),
+ ]
+ );
- $this->schemaIdCache = [];
+ $this->schemaIdCache = [];
$this->registerIdCache = [];
$this->logger->info("SettingsService: Configuration cache cleared");
- }
+ }//end clearConfigurationCache()
/**
* Gets the configured register ID for the voorzieningen register
@@ -872,80 +968,110 @@ public function getVoorzieningenRegisterId(): ?int
{
$startTime = microtime(true);
- $this->logger->debug("SettingsService: Starting voorzieningen register ID lookup", [
- 'timestamp' => date('Y-m-d H:i:s')
- ]);
+ $this->logger->debug(
+ "SettingsService: Starting voorzieningen register ID lookup",
+ [
+ 'timestamp' => date('Y-m-d H:i:s'),
+ ]
+ );
- // Try voorzieningen-specific configuration first
- $this->logger->debug("SettingsService: Checking voorzieningen organisatie register", [
- 'configKey' => 'voorzieningen_organisatie_register'
- ]);
+ // Try voorzieningen-specific configuration first.
+ $this->logger->debug(
+ "SettingsService: Checking voorzieningen organisatie register",
+ [
+ 'configKey' => 'voorzieningen_organisatie_register',
+ ]
+ );
$registerId = $this->config->getValueString($this->_appName, 'voorzieningen_organisatie_register', '');
- $this->logger->debug("SettingsService: Voorzieningen organisatie register result", [
- 'configKey' => 'voorzieningen_organisatie_register',
- 'rawValue' => $registerId,
- 'isEmpty' => empty($registerId)
- ]);
+ $this->logger->debug(
+ "SettingsService: Voorzieningen organisatie register result",
+ [
+ 'configKey' => 'voorzieningen_organisatie_register',
+ 'rawValue' => $registerId,
+ 'isEmpty' => empty($registerId) === true,
+ ]
+ );
- if (!empty($registerId)) {
+ if (empty($registerId) === false) {
$result = (int) $registerId;
- $this->logger->info("SettingsService: Found voorzieningen organisatie register", [
- 'registerId' => $result,
- 'lookupTime' => round((microtime(true) - $startTime) * 1000, 2) . 'ms'
- ]);
+ $this->logger->info(
+ "SettingsService: Found voorzieningen organisatie register",
+ [
+ 'registerId' => $result,
+ 'lookupTime' => round((microtime(true) - $startTime) * 1000, 2).'ms',
+ ]
+ );
return $result;
}
- // Also try contactpersoon as fallback
- $this->logger->debug("SettingsService: Checking voorzieningen contactpersoon register", [
- 'configKey' => 'voorzieningen_contactpersoon_register'
- ]);
+ // Also try contactpersoon as fallback.
+ $this->logger->debug(
+ "SettingsService: Checking voorzieningen contactpersoon register",
+ [
+ 'configKey' => 'voorzieningen_contactpersoon_register',
+ ]
+ );
$registerId = $this->config->getValueString($this->_appName, 'voorzieningen_contactpersoon_register', '');
- $this->logger->debug("SettingsService: Voorzieningen contactpersoon register result", [
- 'configKey' => 'voorzieningen_contactpersoon_register',
- 'rawValue' => $registerId,
- 'isEmpty' => empty($registerId)
- ]);
+ $this->logger->debug(
+ "SettingsService: Voorzieningen contactpersoon register result",
+ [
+ 'configKey' => 'voorzieningen_contactpersoon_register',
+ 'rawValue' => $registerId,
+ 'isEmpty' => empty($registerId) === true,
+ ]
+ );
- if (!empty($registerId)) {
+ if (empty($registerId) === false) {
$result = (int) $registerId;
- $this->logger->info("SettingsService: Found voorzieningen contactpersoon register", [
- 'registerId' => $result,
- 'lookupTime' => round((microtime(true) - $startTime) * 1000, 2) . 'ms'
- ]);
+ $this->logger->info(
+ "SettingsService: Found voorzieningen contactpersoon register",
+ [
+ 'registerId' => $result,
+ 'lookupTime' => round((microtime(true) - $startTime) * 1000, 2).'ms',
+ ]
+ );
return $result;
}
- // Fall back to organization register for backward compatibility
- $this->logger->debug("SettingsService: Checking organization register for backward compatibility", [
- 'configKey' => 'organization_register'
- ]);
+ // Fall back to organization register for backward compatibility.
+ $this->logger->debug(
+ "SettingsService: Checking organization register for backward compatibility",
+ [
+ 'configKey' => 'organization_register',
+ ]
+ );
- $result = $this->getRegisterIdForObjectType('organization');
+ $result = $this->getRegisterIdForObjectType(objectType: 'organization');
if ($result !== null) {
- $this->logger->info("SettingsService: Found organization register for backward compatibility", [
- 'registerId' => $result,
- 'lookupTime' => round((microtime(true) - $startTime) * 1000, 2) . 'ms'
- ]);
+ $this->logger->info(
+ "SettingsService: Found organization register for backward compatibility",
+ [
+ 'registerId' => $result,
+ 'lookupTime' => round((microtime(true) - $startTime) * 1000, 2).'ms',
+ ]
+ );
return $result;
}
- $this->logger->warning("SettingsService: No register ID found for voorzieningen", [
- 'checkedConfigurations' => [
- 'voorzieningen_organisatie_register' => true,
- 'voorzieningen_contactpersoon_register' => true,
- 'organization_register' => true
- ],
- 'lookupTime' => round((microtime(true) - $startTime) * 1000, 2) . 'ms'
- ]);
+ $this->logger->warning(
+ "SettingsService: No register ID found for voorzieningen",
+ [
+ 'checkedConfigurations' => [
+ 'voorzieningen_organisatie_register' => true,
+ 'voorzieningen_contactpersoon_register' => true,
+ 'organization_register' => true,
+ ],
+ 'lookupTime' => round((microtime(true) - $startTime) * 1000, 2).'ms',
+ ]
+ );
return null;
- }
+ }//end getVoorzieningenRegisterId()
/**
* Checks if all required object types are configured
@@ -954,18 +1080,18 @@ public function getVoorzieningenRegisterId(): ?int
*/
public function isFullyConfigured(): bool
{
- // Use contactpersoon instead of contact to match the actual schema naming
+ // Use contactpersoon instead of contact to match the actual schema naming.
$objectTypes = ['organization', 'contactpersoon'];
foreach ($objectTypes as $type) {
- $schemaId = $this->getSchemaIdForObjectType($type);
- if (!$schemaId) {
+ $schemaId = $this->getSchemaIdForObjectType(objectType: $type);
+ if ($schemaId === null) {
return false;
}
}
return true;
- }
+ }//end isFullyConfigured()
/**
* Gets configuration status for each object type
@@ -974,30 +1100,30 @@ public function isFullyConfigured(): bool
*/
public function getConfigurationStatus(): array
{
- // Use the correct object type names that match the schema configuration
+ // Use the correct object type names that match the schema configuration.
$objectTypes = ['organization', 'organisatie', 'contact', 'contactpersoon'];
- $status = [];
+ $status = [];
- // Check organization (can be in AMEF as 'organization' or Voorzieningen as 'organisatie')
- $orgSchemaId = $this->getSchemaIdForObjectType('organization');
- $orgRegisterId = $this->getRegisterIdForObjectType('organization');
+ // Check organization (can be in AMEF as 'organization' or Voorzieningen as 'organisatie').
+ $orgSchemaId = $this->getSchemaIdForObjectType(objectType: 'organization');
+ $orgRegisterId = $this->getRegisterIdForObjectType(objectType: 'organization');
$status['organization'] = [
- 'configured' => !empty($orgSchemaId) && !empty($orgRegisterId),
- 'schemaId' => $orgSchemaId,
+ 'configured' => empty($orgSchemaId) === false && empty($orgRegisterId) === false,
+ 'schemaId' => $orgSchemaId,
'registerId' => $orgRegisterId,
];
- // Check contact (stored as 'contactpersoon' in Voorzieningen)
- $contactSchemaId = $this->getSchemaIdForObjectType('contactpersoon');
- $contactRegisterId = $this->getRegisterIdForObjectType('contactpersoon');
+ // Check contact (stored as 'contactpersoon' in Voorzieningen).
+ $contactSchemaId = $this->getSchemaIdForObjectType(objectType: 'contactpersoon');
+ $contactRegisterId = $this->getRegisterIdForObjectType(objectType: 'contactpersoon');
$status['contact'] = [
- 'configured' => !empty($contactSchemaId) && !empty($contactRegisterId),
- 'schemaId' => $contactSchemaId,
+ 'configured' => empty($contactSchemaId) === false && empty($contactRegisterId) === false,
+ 'schemaId' => $contactSchemaId,
'registerId' => $contactRegisterId,
];
return $status;
- }
+ }//end getConfigurationStatus()
/**
* Initializes the app with all required components
@@ -1006,147 +1132,176 @@ public function getConfigurationStatus(): array
*
* @return array The initialization results
*/
- public function initialize(?string $minOpenRegisterVersion = self::MIN_OPENREGISTER_VERSION): array
+ public function initialize(?string $minOpenRegisterVersion=self::MIN_OPENREGISTER_VERSION): array
{
$startTime = microtime(true);
- $results = [
- 'openRegister' => false,
- 'autoConfigured' => false,
- 'fullyConfigured' => false,
- 'settingsLoaded' => false,
+ $results = [
+ 'openRegister' => false,
+ 'autoConfigured' => false,
+ 'fullyConfigured' => false,
+ 'settingsLoaded' => false,
'configurationImported' => false,
'autoConfigAfterImport' => false,
- 'errors' => [],
- 'warnings' => [],
- 'timing' => []
+ 'errors' => [],
+ 'warnings' => [],
+ 'timing' => [],
];
- $this->logger->info('SettingsService: Starting initialization', [
- 'minOpenRegisterVersion' => $minOpenRegisterVersion
- ]);
+ $this->logger->info(
+ 'SettingsService: Starting initialization',
+ [
+ 'minOpenRegisterVersion' => $minOpenRegisterVersion,
+ ]
+ );
try {
- // Check if OpenRegister is installed and enabled
+ // Check if OpenRegister is installed and enabled.
$checkStart = microtime(true);
- if (!$this->isOpenRegisterInstalled($minOpenRegisterVersion)) {
+ if ($this->isOpenRegisterInstalled(minVersion: $minOpenRegisterVersion) === false) {
$error = 'OpenRegister is not installed or does not meet minimum version requirements';
$results['errors'][] = $error;
- $this->logger->error('SettingsService: ' . $error);
+ $this->logger->error('SettingsService: '.$error);
return $results;
}
- if (!$this->isOpenRegisterEnabled()) {
+ if ($this->isOpenRegisterEnabled() === false) {
$error = 'OpenRegister is not enabled';
$results['errors'][] = $error;
- $this->logger->error('SettingsService: ' . $error);
+ $this->logger->error('SettingsService: '.$error);
return $results;
}
$results['openRegister'] = true;
- $results['timing']['openregister_check'] = round((microtime(true) - $checkStart) * 1000, 2) . 'ms';
+ $results['timing']['openregister_check'] = round((microtime(true) - $checkStart) * 1000, 2).'ms';
$this->logger->info('SettingsService: OpenRegister is available');
- // Load settings from file if needed (do this first)
+ // Load settings from file if needed (do this first).
$loadStart = microtime(true);
try {
- if ($this->shouldLoadSettings()) {
+ if ($this->shouldLoadSettings() === true) {
$this->logger->info('SettingsService: Loading settings from file');
$loadResult = $this->loadSettings();
- $results['settingsLoaded'] = true;
- $results['configurationImported'] = !empty($loadResult['softwarecatalog_imported']);
- $this->logger->info('SettingsService: Settings loaded successfully', [
- 'imported' => $results['configurationImported']
- ]);
+ $results['settingsLoaded'] = true;
+ $results['configurationImported'] = empty($loadResult['softwarecatalog_imported']) === false;
+ $this->logger->info(
+ 'SettingsService: Settings loaded successfully',
+ [
+ 'imported' => $results['configurationImported'],
+ ]
+ );
} else {
- $results['settingsLoaded'] = true; // Already up to date
+ $results['settingsLoaded'] = true;
+ // Already up to date.
$this->logger->info('SettingsService: Settings already up to date');
}
} catch (\Exception $e) {
- $error = 'Settings loading failed: ' . $e->getMessage();
+ $error = 'Settings loading failed: '.$e->getMessage();
$results['errors'][] = $error;
- $this->logger->error('SettingsService: ' . $error, [
- 'exception' => $e
- ]);
- }
- $results['timing']['settings_load'] = round((microtime(true) - $loadStart) * 1000, 2) . 'ms';
+ $this->logger->error(
+ 'SettingsService: '.$error,
+ [
+ 'exception' => $e,
+ ]
+ );
+ }//end try
+
+ $results['timing']['settings_load'] = round((microtime(true) - $loadStart) * 1000, 2).'ms';
- // Try auto-configuration after import if not already configured
+ // Try auto-configuration after import if not already configured.
$autoConfigStart = microtime(true);
- if (!$this->isFullyConfigured()) {
+ if ($this->isFullyConfigured() === false) {
$this->logger->info('SettingsService: App not fully configured, attempting auto-configuration');
try {
- // First try the post-import auto-configuration (more specific)
+ // First try the post-import auto-configuration (more specific).
$configuration = $this->autoConfigureAfterImport();
- if (!empty($configuration)) {
- $this->updateSettings($configuration);
+ if (empty($configuration) === false) {
+ $this->updateSettings(data: $configuration);
$results['autoConfigAfterImport'] = true;
- $results['autoConfigured'] = true;
- $this->logger->info('SettingsService: Auto-configuration after import successful', [
- 'configuration' => array_keys($configuration)
- ]);
+ $results['autoConfigured'] = true;
+ $this->logger->info(
+ 'SettingsService: Auto-configuration after import successful',
+ [
+ 'configuration' => array_keys($configuration),
+ ]
+ );
} else {
- // Fallback to general auto-configuration
+ // Fallback to general auto-configuration.
$this->logger->info('SettingsService: Post-import auto-config yielded no results, trying general auto-config');
$configuration = $this->autoConfigure();
- if (!empty($configuration)) {
- $this->updateSettings($configuration);
+ if (empty($configuration) === false) {
+ $this->updateSettings(data: $configuration);
$results['autoConfigured'] = true;
- $this->logger->info('SettingsService: General auto-configuration successful', [
- 'configuration' => array_keys($configuration)
- ]);
+ $this->logger->info(
+ 'SettingsService: General auto-configuration successful',
+ [
+ 'configuration' => array_keys($configuration),
+ ]
+ );
}
- }
+ }//end if
} catch (\Exception $e) {
- $error = 'Auto-configuration failed: ' . $e->getMessage();
+ $error = 'Auto-configuration failed: '.$e->getMessage();
$results['errors'][] = $error;
- $this->logger->error('SettingsService: ' . $error, [
- 'exception' => $e
- ]);
- }
+ $this->logger->error(
+ 'SettingsService: '.$error,
+ [
+ 'exception' => $e,
+ ]
+ );
+ }//end try
} else {
$this->logger->info('SettingsService: App is already fully configured');
- }
- $results['timing']['auto_config'] = round((microtime(true) - $autoConfigStart) * 1000, 2) . 'ms';
+ }//end if
- // Final configuration status check
+ $results['timing']['auto_config'] = round((microtime(true) - $autoConfigStart) * 1000, 2).'ms';
+
+ // Final configuration status check.
$results['fullyConfigured'] = $this->isFullyConfigured();
- if (!$results['fullyConfigured']) {
+ if ($results['fullyConfigured'] === false) {
$warning = 'App is not fully configured after initialization. Manual configuration may be required.';
$results['warnings'][] = $warning;
- $this->logger->warning('SettingsService: ' . $warning, [
- 'configStatus' => $this->getConfigurationStatus()
- ]);
+ $this->logger->warning(
+ 'SettingsService: '.$warning,
+ [
+ 'configStatus' => $this->getConfigurationStatus(),
+ ]
+ );
}
- $results['timing']['total'] = round((microtime(true) - $startTime) * 1000, 2) . 'ms';
-
- $this->logger->info('SettingsService: Initialization completed', [
- 'results' => [
- 'openRegister' => $results['openRegister'],
- 'autoConfigured' => $results['autoConfigured'],
- 'fullyConfigured' => $results['fullyConfigured'],
- 'settingsLoaded' => $results['settingsLoaded'],
- 'errors' => count($results['errors']),
- 'warnings' => count($results['warnings'])
- ],
- 'timing' => $results['timing']
- ]);
+ $results['timing']['total'] = round((microtime(true) - $startTime) * 1000, 2).'ms';
+ $this->logger->info(
+ 'SettingsService: Initialization completed',
+ [
+ 'results' => [
+ 'openRegister' => $results['openRegister'],
+ 'autoConfigured' => $results['autoConfigured'],
+ 'fullyConfigured' => $results['fullyConfigured'],
+ 'settingsLoaded' => $results['settingsLoaded'],
+ 'errors' => count($results['errors']),
+ 'warnings' => count($results['warnings']),
+ ],
+ 'timing' => $results['timing'],
+ ]
+ );
} catch (\Exception $e) {
- $error = 'Initialization failed: ' . $e->getMessage();
+ $error = 'Initialization failed: '.$e->getMessage();
$results['errors'][] = $error;
- $this->logger->error('SettingsService: ' . $error, [
- 'exception' => $e,
- 'trace' => $e->getTraceAsString()
- ]);
- }
+ $this->logger->error(
+ 'SettingsService: '.$error,
+ [
+ 'exception' => $e,
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
+ }//end try
return $results;
- }
+ }//end initialize()
/**
* Load settings from register configuration files
@@ -1157,21 +1312,21 @@ public function initialize(?string $minOpenRegisterVersion = self::MIN_OPENREGIS
*
* @throws \RuntimeException If settings loading fails
*/
- public function loadSettings(bool $force = false): array
+ public function loadSettings(bool $force=false): array
{
$results = [];
try {
- // Load settings from merged softwarecatalogus_register.json (magic mapper enabled for performance)
- $softwareCatalogPath = __DIR__ . '/../Settings/softwarecatalogus_register.json';
- if (file_exists($softwareCatalogPath)) {
- $softwareCatalogContent = file_get_contents($softwareCatalogPath);
+ // Load settings from merged softwarecatalogus_register.json (magic mapper enabled for performance).
+ $softwareCatalogPath = __DIR__.'/../Settings/softwarecatalogus_register.json';
+ if (file_exists($softwareCatalogPath) === true) {
+ $softwareCatalogContent = file_get_contents($softwareCatalogPath);
$softwareCatalogSettings = json_decode($softwareCatalogContent, true);
if (json_last_error() === JSON_ERROR_NONE) {
$results['softwarecatalog'] = $softwareCatalogSettings;
- // Import via configuration service if available with version checking
+ // Import via configuration service if available with version checking.
try {
$configurationService = $this->getConfigurationService();
@@ -1179,15 +1334,18 @@ public function loadSettings(bool $force = false): array
// This ensures changes to the JSON file trigger re-import even if app version is unchanged.
$configVersion = $softwareCatalogSettings['info']['version'] ?? '0.0.0';
- // Log the import attempt for debugging
- $this->logger->info('SettingsService: Attempting to import softwarecatalogus_register.json', [
- 'force' => $force,
- 'app_id' => \OCA\SoftwareCatalog\AppInfo\Application::APP_ID,
- 'config_version' => $configVersion,
- 'data_size' => strlen(json_encode($softwareCatalogSettings))
- ]);
-
- // Use importFromApp which handles Configuration entity creation automatically
+ // Log the import attempt for debugging.
+ $this->logger->info(
+ 'SettingsService: Attempting to import softwarecatalogus_register.json',
+ [
+ 'force' => $force,
+ 'app_id' => \OCA\SoftwareCatalog\AppInfo\Application::APP_ID,
+ 'config_version' => $configVersion,
+ 'data_size' => strlen(json_encode($softwareCatalogSettings)),
+ ]
+ );
+
+ // Use importFromApp which handles Configuration entity creation automatically.
$importResult = $configurationService->importFromApp(
appId: \OCA\SoftwareCatalog\AppInfo\Application::APP_ID,
data: $softwareCatalogSettings,
@@ -1195,39 +1353,44 @@ public function loadSettings(bool $force = false): array
force: $force
);
- $this->logger->info('SettingsService: Import completed successfully', [
- 'import_result' => $importResult
- ]);
+ $this->logger->info(
+ 'SettingsService: Import completed successfully',
+ [
+ 'import_result' => $importResult,
+ ]
+ );
$results['softwarecatalog_imported'] = true;
- $results['import_result'] = $importResult;
+ $results['import_result'] = $importResult;
} catch (\Exception $e) {
$results['softwarecatalog_import_error'] = $e->getMessage();
- $this->logger->error('Failed to import softwarecatalog settings: ' . $e->getMessage(), [
- 'exception' => $e,
- 'trace' => $e->getTraceAsString(),
- 'force_flag' => $force,
- 'app_id' => \OCA\SoftwareCatalog\AppInfo\Application::APP_ID
- ]);
-
- // In force mode, we want to surface import errors more prominently
- if ($force) {
- throw new \RuntimeException('Force import failed: ' . $e->getMessage(), 0, $e);
+ $this->logger->error(
+ 'Failed to import softwarecatalog settings: '.$e->getMessage(),
+ [
+ 'exception' => $e,
+ 'trace' => $e->getTraceAsString(),
+ 'force_flag' => $force,
+ 'app_id' => \OCA\SoftwareCatalog\AppInfo\Application::APP_ID,
+ ]
+ );
+
+ // In force mode, we want to surface import errors more prominently.
+ if (empty($force) === false) {
+ throw new \RuntimeException('Force import failed: '.$e->getMessage(), 0, $e);
}
- }
- }
- }
+ }//end try
+ }//end if
+ }//end if
- if (empty($results)) {
+ if (empty($results) === true) {
throw new \Exception('No register configuration files found');
}
return $results;
-
} catch (\Exception $e) {
- throw new \RuntimeException('Failed to load settings: ' . $e->getMessage());
- }
- }
+ throw new \RuntimeException('Failed to load settings: '.$e->getMessage());
+ }//end try
+ }//end loadSettings()
/**
* Gets the list of generic user groups from configuration
@@ -1238,17 +1401,21 @@ public function getGenericUserGroups(): array
{
$groupsJson = $this->config->getValueString($this->_appName, 'generic_user_groups', '');
- if (empty($groupsJson)) {
- // Return only truly generic groups as default (not role-specific)
- // Role-specific groups are now assigned based on organization type
+ if (empty($groupsJson) === true) {
+ // Return only truly generic groups as default (not role-specific).
+ // Role-specific groups are now assigned based on organization type.
return [
'software-catalog-users'
];
}
$groups = json_decode($groupsJson, true);
- return is_array($groups) ? $groups : [];
- }
+ if (is_array($groups) === true) {
+ return $groups;
+ } else {
+ return [];
+ }
+ }//end getGenericUserGroups()
/**
* Sets the list of generic user groups in configuration
@@ -1265,10 +1432,10 @@ public function setGenericUserGroups(array $groups): void
$this->logger->info(
'Updated generic user groups configuration',
[
- 'groups' => $groups
+ 'groups' => $groups,
]
);
- }
+ }//end setGenericUserGroups()
/**
* Gets the list of organization admin groups from configuration
@@ -1277,11 +1444,11 @@ public function setGenericUserGroups(array $groups): void
*/
public function getOrganizationAdminGroups(): array
{
- // DISABLED: No automatic group assignment for organization admins
- // Users should be assigned groups explicitly via the admin UI
- // Previously this returned ['organisaties-beheerder', 'organisatie-beheerder'] by default
+ // DISABLED: No automatic group assignment for organization admins.
+ // Users should be assigned groups explicitly via the admin UI.
+ // Previously this returned ['organisaties-beheerder', 'organisatie-beheerder'] by default.
return [];
- }
+ }//end getOrganizationAdminGroups()
/**
* Sets the list of organization admin groups in configuration
@@ -1298,10 +1465,10 @@ public function setOrganizationAdminGroups(array $groups): void
$this->logger->info(
'Updated organization admin groups configuration',
[
- 'groups' => $groups
+ 'groups' => $groups,
]
);
- }
+ }//end setOrganizationAdminGroups()
/**
* Gets the list of super user groups from configuration
@@ -1312,17 +1479,21 @@ public function getSuperUserGroups(): array
{
$groupsJson = $this->config->getValueString($this->_appName, 'super_user_groups', '');
- if (empty($groupsJson)) {
- // Return default groups if no configuration exists
+ if (empty($groupsJson) === true) {
+ // Return default groups if no configuration exists.
return [
'admin',
- 'software-catalog-admins'
+ 'software-catalog-admins',
];
}
$groups = json_decode($groupsJson, true);
- return is_array($groups) ? $groups : [];
- }
+ if (is_array($groups) === true) {
+ return $groups;
+ } else {
+ return [];
+ }
+ }//end getSuperUserGroups()
/**
* Sets the list of super user groups in configuration
@@ -1339,10 +1510,10 @@ public function setSuperUserGroups(array $groups): void
$this->logger->info(
'Updated super user groups configuration',
[
- 'groups' => $groups
+ 'groups' => $groups,
]
);
- }
+ }//end setSuperUserGroups()
/**
* Validates a list of group names
@@ -1354,22 +1525,22 @@ public function setSuperUserGroups(array $groups): void
public function validateGroups(array $groups): array
{
$results = [
- 'valid' => [],
+ 'valid' => [],
'invalid' => [],
- 'errors' => []
+ 'errors' => [],
];
foreach ($groups as $groupName) {
- if (empty($groupName) || !is_string($groupName)) {
+ if (empty($groupName) === true || is_string($groupName) === false) {
$results['invalid'][] = $groupName;
- $results['errors'][] = 'Group name cannot be empty';
+ $results['errors'][] = 'Group name cannot be empty';
continue;
}
- // Check for invalid characters
- if (preg_match('/[^a-zA-Z0-9._-]/', $groupName)) {
+ // Check for invalid characters.
+ if (preg_match('/[^a-zA-Z0-9._-]/', $groupName) === 1) {
$results['invalid'][] = $groupName;
- $results['errors'][] = "Group name '{$groupName}' contains invalid characters";
+ $results['errors'][] = "Group name '{$groupName}' contains invalid characters";
continue;
}
@@ -1377,7 +1548,7 @@ public function validateGroups(array $groups): array
}
return $results;
- }
+ }//end validateGroups()
/**
* Creates and configures required user groups for the software catalog
@@ -1392,48 +1563,48 @@ public function createAndConfigureUserGroups(): array
$this->logger->info('SettingsService: Starting user group creation and configuration');
$result = [
- 'success' => true,
- 'message' => 'User groups configured successfully',
- 'created' => [],
+ 'success' => true,
+ 'message' => 'User groups configured successfully',
+ 'created' => [],
'existing' => [],
- 'total' => 0
+ 'total' => 0,
];
- // Get the group manager
+ // Get the group manager.
$groupManager = \OC::$server->getGroupManager();
- // Define the required groups (matching role-based system)
+ // Define the required groups (matching role-based system).
$requiredGroups = [
- // Role-based user groups (exact match with ContactPersoon roles)
- 'aanbod-beheerder' => 'Manages software offerings and catalog content',
- 'gebruik-beheerder' => 'Manages software usage and procurement',
- 'gebruik-raadpleger' => 'Views software usage and procurement data',
- 'functioneel-beheerder' => 'Manages functional aspects of the system',
- 'vng-raadpleger' => 'Views VNG-related information',
- 'organisatie-beheerder' => 'Manages organization data and settings',
-
- // Plural form for organization contacts
- 'organisaties-beheerder' => 'Organization administrators (plural)',
-
- // Special groups (available for manual assignment)
- 'ambtenaar' => 'Civil servants - available for manual assignment (no automatic assignment)',
- 'software-catalog-users' => 'General software catalog users',
-
- // Super user groups
- 'software-catalog-admins' => 'Software catalog system administrators'
+ // Role-based user groups (exact match with ContactPersoon roles).
+ 'aanbod-beheerder' => 'Manages software offerings and catalog content',
+ 'gebruik-beheerder' => 'Manages software usage and procurement',
+ 'gebruik-raadpleger' => 'Views software usage and procurement data',
+ 'functioneel-beheerder' => 'Manages functional aspects of the system',
+ 'vng-raadpleger' => 'Views VNG-related information',
+ 'organisatie-beheerder' => 'Manages organization data and settings',
+
+ // Plural form for organization contacts.
+ 'organisaties-beheerder' => 'Organization administrators (plural)',
+
+ // Special groups (available for manual assignment).
+ 'ambtenaar' => 'Civil servants - available for manual assignment (no automatic assignment)',
+ 'software-catalog-users' => 'General software catalog users',
+
+ // Super user groups.
+ 'software-catalog-admins' => 'Software catalog system administrators',
];
foreach ($requiredGroups as $groupId => $description) {
$this->logger->debug("SettingsService: Processing group: {$groupId}");
- // Check if group already exists
- if ($groupManager->groupExists($groupId)) {
+ // Check if group already exists.
+ if ($groupManager->groupExists($groupId) === true) {
$result['existing'][] = $groupId;
$this->logger->debug("SettingsService: Group {$groupId} already exists");
continue;
}
- // Create the group
+ // Create the group.
$group = $groupManager->createGroup($groupId);
if ($group !== false) {
$result['created'][] = $groupId;
@@ -1446,21 +1617,26 @@ public function createAndConfigureUserGroups(): array
$result['total'] = count($requiredGroups);
- // Update the configuration with only truly generic groups (not role-specific)
- // Role-specific groups are now assigned based on organization type
- $this->setGenericUserGroups([
- 'software-catalog-users'
- ]);
+ // Update the configuration with only truly generic groups (not role-specific).
+ // Role-specific groups are now assigned based on organization type.
+ $this->setGenericUserGroups(
+ groups: [
+ 'software-catalog-users',
+ ]
+ );
- // No automatic organization admin groups - can be configured via settings
- $this->setOrganizationAdminGroups([]);
+ // No automatic organization admin groups - can be configured via settings.
+ $this->setOrganizationAdminGroups(groups: []);
- $this->setSuperUserGroups([
- 'admin', // Keep existing admin group
- 'software-catalog-admins'
- ]);
+ $this->setSuperUserGroups(
+ groups: [
+ // Keep existing admin group.
+ 'admin',
+ 'software-catalog-admins',
+ ]
+ );
- $createdCount = count($result['created']);
+ $createdCount = count($result['created']);
$existingCount = count($result['existing']);
if ($createdCount > 0) {
@@ -1469,29 +1645,34 @@ public function createAndConfigureUserGroups(): array
$result['message'] = "All {$existingCount} required groups already exist";
}
- $this->logger->info('SettingsService: User group creation and configuration completed', [
- 'created_groups' => $result['created'],
- 'existing_groups' => $result['existing'],
- 'total_required' => $result['total'],
- 'success' => $result['success']
- ]);
+ $this->logger->info(
+ 'SettingsService: User group creation and configuration completed',
+ [
+ 'created_groups' => $result['created'],
+ 'existing_groups' => $result['existing'],
+ 'total_required' => $result['total'],
+ 'success' => $result['success'],
+ ]
+ );
return $result;
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to create and configure user groups', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to create and configure user groups',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
- 'success' => false,
- 'message' => 'Failed to create user groups: ' . $e->getMessage(),
- 'created' => [],
+ 'success' => false,
+ 'message' => 'Failed to create user groups: '.$e->getMessage(),
+ 'created' => [],
'existing' => [],
- 'total' => 0,
- 'error' => $e->getMessage()
+ 'total' => 0,
+ 'error' => $e->getMessage(),
];
- }
- }
+ }//end try
+ }//end createAndConfigureUserGroups()
/**
* Creates required user groups for the software catalog
@@ -1510,44 +1691,44 @@ private function createRequiredUserGroups(): void
try {
$this->logger->info('Starting creation of required user groups');
- // Get the group manager
+ // Get the group manager.
$groupManager = \OC::$server->getGroupManager();
- // Define the required groups (matching role-based system)
+ // Define the required groups (matching role-based system).
$requiredGroups = [
- // Role-based user groups (exact match with ContactPersoon roles)
- 'aanbod-beheerder' => 'Manages software offerings and catalog content',
- 'gebruik-beheerder' => 'Manages software usage and procurement',
- 'gebruik-raadpleger' => 'Views software usage and procurement data',
- 'functioneel-beheerder' => 'Manages functional aspects of the system',
- 'vng-raadpleger' => 'Views VNG-related information',
- 'organisatie-beheerder' => 'Manages organization data and settings',
-
- // Plural form for organization contacts
- 'organisaties-beheerder' => 'Organization administrators (plural)',
-
- // Special groups (available for manual assignment)
- 'ambtenaar' => 'Civil servants - available for manual assignment (no automatic assignment)',
- 'software-catalog-users' => 'General software catalog users',
-
- // Super user groups
- 'software-catalog-admins' => 'Software catalog system administrators'
+ // Role-based user groups (exact match with ContactPersoon roles).
+ 'aanbod-beheerder' => 'Manages software offerings and catalog content',
+ 'gebruik-beheerder' => 'Manages software usage and procurement',
+ 'gebruik-raadpleger' => 'Views software usage and procurement data',
+ 'functioneel-beheerder' => 'Manages functional aspects of the system',
+ 'vng-raadpleger' => 'Views VNG-related information',
+ 'organisatie-beheerder' => 'Manages organization data and settings',
+
+ // Plural form for organization contacts.
+ 'organisaties-beheerder' => 'Organization administrators (plural)',
+
+ // Special groups (available for manual assignment).
+ 'ambtenaar' => 'Civil servants - available for manual assignment (no automatic assignment)',
+ 'software-catalog-users' => 'General software catalog users',
+
+ // Super user groups.
+ 'software-catalog-admins' => 'Software catalog system administrators',
];
- $createdGroups = [];
+ $createdGroups = [];
$existingGroups = [];
foreach ($requiredGroups as $groupId => $description) {
$this->logger->debug("Processing group: {$groupId}");
- // Check if group already exists
- if ($groupManager->groupExists($groupId)) {
+ // Check if group already exists.
+ if ($groupManager->groupExists($groupId) === true) {
$existingGroups[] = $groupId;
$this->logger->debug("Group {$groupId} already exists, skipping");
continue;
}
- // Create the group
+ // Create the group.
$group = $groupManager->createGroup($groupId);
if ($group !== false) {
$createdGroups[] = $groupId;
@@ -1557,33 +1738,43 @@ private function createRequiredUserGroups(): void
}
}
- // Update the configuration with only truly generic groups (not role-specific)
- // Role-specific groups are now assigned based on organization type, not as generic groups
- $this->setGenericUserGroups([
- 'software-catalog-users'
- ]);
-
- // No automatic organization admin groups - can be configured via settings
- $this->setOrganizationAdminGroups([]);
+ // Update the configuration with only truly generic groups (not role-specific).
+ // Role-specific groups are now assigned based on organization type, not as generic groups.
+ $this->setGenericUserGroups(
+ groups: [
+ 'software-catalog-users',
+ ]
+ );
- $this->setSuperUserGroups([
- 'admin', // Keep existing admin group
- 'software-catalog-admins'
- ]);
+ // No automatic organization admin groups - can be configured via settings.
+ $this->setOrganizationAdminGroups(groups: []);
- $this->logger->info('User group creation completed', [
- 'created_groups' => $createdGroups,
- 'existing_groups' => $existingGroups,
- 'total_required' => count($requiredGroups)
- ]);
+ $this->setSuperUserGroups(
+ groups: [
+ // Keep existing admin group.
+ 'admin',
+ 'software-catalog-admins',
+ ]
+ );
+ $this->logger->info(
+ 'User group creation completed',
+ [
+ 'created_groups' => $createdGroups,
+ 'existing_groups' => $existingGroups,
+ 'total_required' => count($requiredGroups),
+ ]
+ );
} catch (\Exception $e) {
- $this->logger->error('Failed to create required user groups: ' . $e->getMessage(), [
- 'exception' => $e
- ]);
- throw new \RuntimeException('Failed to create required user groups: ' . $e->getMessage());
- }
- }
+ $this->logger->error(
+ 'Failed to create required user groups: '.$e->getMessage(),
+ [
+ 'exception' => $e,
+ ]
+ );
+ throw new \RuntimeException('Failed to create required user groups: '.$e->getMessage());
+ }//end try
+ }//end createRequiredUserGroups()
/**
* Gets all available groups with their information
@@ -1594,27 +1785,27 @@ public function getAllGroups(): array
{
$groups = [];
- // Get group manager if possible
- if ($this->appManager->isInstalled('user_management')) {
+ // Get group manager if possible.
+ if ($this->appManager->isInstalled('user_management') === true) {
try {
$groupManager = \OC::$server->getGroupManager();
- $allGroups = $groupManager->search('');
+ $allGroups = $groupManager->search('');
foreach ($allGroups as $group) {
$groups[] = [
- 'id' => $group->getGID(),
+ 'id' => $group->getGID(),
'displayName' => $group->getDisplayName(),
- 'memberCount' => count($group->getUsers()),
- 'isGeneric' => in_array($group->getGID(), $this->getGenericUserGroups())
+ 'memberCount' => count($group->getUsers() === true),
+ 'isGeneric' => in_array($group->getGID(), $this->getGenericUserGroups()) === true,
];
}
} catch (\Exception $e) {
- $this->logger->error('Failed to get all groups: ' . $e->getMessage());
+ $this->logger->error('Failed to get all groups: '.$e->getMessage());
}
}
return $groups;
- }
+ }//end getAllGroups()
/**
* Gets email configuration settings
@@ -1626,67 +1817,70 @@ public function getEmailSettings(): array
$this->logger->debug('SoftwareCatalog: Loading email settings from configuration');
$settings = [
- 'enabled' => $this->config->getValueString($this->_appName, 'email_enabled', 'false') === 'true',
- 'senderEmail' => $this->config->getValueString($this->_appName, 'sender_email', 'noreply@softwarecatalogus.nl'),
- 'senderName' => $this->config->getValueString($this->_appName, 'sender_name', 'Software Catalogus'),
- 'testReceiverOverride' => $this->config->getValueString($this->_appName, 'test_receiver_override', ''),
+ 'enabled' => $this->config->getValueString($this->_appName, 'email_enabled', 'false') === 'true',
+ 'senderEmail' => $this->config->getValueString($this->_appName, 'sender_email', 'noreply@softwarecatalogus.nl'),
+ 'senderName' => $this->config->getValueString($this->_appName, 'sender_name', 'Software Catalogus'),
+ 'testReceiverOverride' => $this->config->getValueString($this->_appName, 'test_receiver_override', ''),
'organizationRegistrationEnabled' => $this->config->getValueString($this->_appName, 'email_org_registration_enabled', 'true') === 'true',
- 'organizationActivationEnabled' => $this->config->getValueString($this->_appName, 'email_org_activation_enabled', 'true') === 'true',
- 'userCreationEnabled' => $this->config->getValueString($this->_appName, 'email_user_creation_enabled', 'true') === 'true',
- 'userPasswordEnabled' => $this->config->getValueString($this->_appName, 'email_user_password_enabled', 'true') === 'true',
- 'userOrganisationEnabled' => $this->config->getValueString($this->_appName, 'email_user_organisation_enabled', 'true') === 'true',
-
- // Symfony Mailer transport configuration
- 'transportType' => $this->config->getValueString($this->_appName, 'email_transport_type', 'smtp'),
-
- // SMTP configuration
- 'smtpHost' => $this->config->getValueString($this->_appName, 'email_smtp_host', 'localhost'),
- 'smtpPort' => (int) $this->config->getValueString($this->_appName, 'email_smtp_port', '587'),
- 'smtpEncryption' => $this->config->getValueString($this->_appName, 'email_smtp_encryption', 'tls'),
- 'smtpUsername' => $this->config->getValueString($this->_appName, 'email_smtp_username', ''),
- 'smtpPassword' => $this->config->getValueString($this->_appName, 'email_smtp_password', ''),
-
- // SendGrid configuration
- 'sendgridApiKey' => $this->config->getValueString($this->_appName, 'email_sendgrid_api_key', ''),
-
- // Mailgun configuration
- 'mailgunApiKey' => $this->config->getValueString($this->_appName, 'email_mailgun_api_key', ''),
- 'mailgunDomain' => $this->config->getValueString($this->_appName, 'email_mailgun_domain', ''),
-
- // Postmark configuration
- 'postmarkApiKey' => $this->config->getValueString($this->_appName, 'email_postmark_api_key', ''),
-
- // Amazon SES configuration
- 'sesAccessKey' => $this->config->getValueString($this->_appName, 'email_ses_access_key', ''),
- 'sesSecretKey' => $this->config->getValueString($this->_appName, 'email_ses_secret_key', ''),
- 'sesRegion' => $this->config->getValueString($this->_appName, 'email_ses_region', 'us-east-1'),
-
- // Mailjet configuration
- 'mailjetApiKey' => $this->config->getValueString($this->_appName, 'email_mailjet_api_key', ''),
- 'mailjetSecretKey' => $this->config->getValueString($this->_appName, 'email_mailjet_secret_key', ''),
-
- // Templates
- 'templates' => [
- 'organization_registration' => $this->getEmailTemplate('organization_registration'),
- 'organization_activation' => $this->getEmailTemplate('organization_activation'),
- 'user_creation' => $this->getEmailTemplate('user_creation'),
- 'user_password' => $this->getEmailTemplate('user_password'),
- ]
+ 'organizationActivationEnabled' => $this->config->getValueString($this->_appName, 'email_org_activation_enabled', 'true') === 'true',
+ 'userCreationEnabled' => $this->config->getValueString($this->_appName, 'email_user_creation_enabled', 'true') === 'true',
+ 'userPasswordEnabled' => $this->config->getValueString($this->_appName, 'email_user_password_enabled', 'true') === 'true',
+ 'userOrganisationEnabled' => $this->config->getValueString($this->_appName, 'email_user_organisation_enabled', 'true') === 'true',
+
+ // Symfony Mailer transport configuration.
+ 'transportType' => $this->config->getValueString($this->_appName, 'email_transport_type', 'smtp'),
+
+ // SMTP configuration.
+ 'smtpHost' => $this->config->getValueString($this->_appName, 'email_smtp_host', 'localhost'),
+ 'smtpPort' => (int) $this->config->getValueString($this->_appName, 'email_smtp_port', '587'),
+ 'smtpEncryption' => $this->config->getValueString($this->_appName, 'email_smtp_encryption', 'tls'),
+ 'smtpUsername' => $this->config->getValueString($this->_appName, 'email_smtp_username', ''),
+ 'smtpPassword' => $this->config->getValueString($this->_appName, 'email_smtp_password', ''),
+
+ // SendGrid configuration.
+ 'sendgridApiKey' => $this->config->getValueString($this->_appName, 'email_sendgrid_api_key', ''),
+
+ // Mailgun configuration.
+ 'mailgunApiKey' => $this->config->getValueString($this->_appName, 'email_mailgun_api_key', ''),
+ 'mailgunDomain' => $this->config->getValueString($this->_appName, 'email_mailgun_domain', ''),
+
+ // Postmark configuration.
+ 'postmarkApiKey' => $this->config->getValueString($this->_appName, 'email_postmark_api_key', ''),
+
+ // Amazon SES configuration.
+ 'sesAccessKey' => $this->config->getValueString($this->_appName, 'email_ses_access_key', ''),
+ 'sesSecretKey' => $this->config->getValueString($this->_appName, 'email_ses_secret_key', ''),
+ 'sesRegion' => $this->config->getValueString($this->_appName, 'email_ses_region', 'us-east-1'),
+
+ // Mailjet configuration.
+ 'mailjetApiKey' => $this->config->getValueString($this->_appName, 'email_mailjet_api_key', ''),
+ 'mailjetSecretKey' => $this->config->getValueString($this->_appName, 'email_mailjet_secret_key', ''),
+
+ // Templates.
+ 'templates' => [
+ 'organization_registration' => $this->getEmailTemplate(templateName: 'organization_registration'),
+ 'organization_activation' => $this->getEmailTemplate(templateName: 'organization_activation'),
+ 'user_creation' => $this->getEmailTemplate(templateName: 'user_creation'),
+ 'user_password' => $this->getEmailTemplate(templateName: 'user_password'),
+ ],
];
- $this->logger->info('SoftwareCatalog: Email settings loaded from configuration', [
- 'enabled' => $settings['enabled'],
- 'transport_type' => $settings['transportType'],
- 'sender_email' => $settings['senderEmail'],
- 'has_mailjet_api_key' => !empty($settings['mailjetApiKey']),
- 'mailjet_api_key_length' => strlen($settings['mailjetApiKey']),
- 'has_mailjet_secret_key' => !empty($settings['mailjetSecretKey']),
- 'mailjet_secret_key_length' => strlen($settings['mailjetSecretKey']),
- 'test_receiver_override' => $settings['testReceiverOverride']
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: Email settings loaded from configuration',
+ [
+ 'enabled' => $settings['enabled'],
+ 'transport_type' => $settings['transportType'],
+ 'sender_email' => $settings['senderEmail'],
+ 'has_mailjet_api_key' => empty($settings['mailjetApiKey']) === false,
+ 'mailjet_api_key_length' => strlen($settings['mailjetApiKey']),
+ 'has_mailjet_secret_key' => empty($settings['mailjetSecretKey']) === false,
+ 'mailjet_secret_key_length' => strlen($settings['mailjetSecretKey']),
+ 'test_receiver_override' => $settings['testReceiverOverride'],
+ ]
+ );
return $settings;
- }
+ }//end getEmailSettings()
/**
* Updates email configuration settings
@@ -1698,54 +1892,58 @@ public function getEmailSettings(): array
public function updateEmailSettings(array $emailSettings): array
{
$allowedSettings = [
- 'enabled' => 'email_enabled',
- 'senderEmail' => 'sender_email',
- 'senderName' => 'sender_name',
- 'testReceiverOverride' => 'test_receiver_override',
+ 'enabled' => 'email_enabled',
+ 'senderEmail' => 'sender_email',
+ 'senderName' => 'sender_name',
+ 'testReceiverOverride' => 'test_receiver_override',
'organizationRegistrationEnabled' => 'email_org_registration_enabled',
- 'organizationActivationEnabled' => 'email_org_activation_enabled',
- 'userCreationEnabled' => 'email_user_creation_enabled',
- 'userPasswordEnabled' => 'email_user_password_enabled',
- 'userOrganisationEnabled' => 'email_user_organisation_enabled',
-
- // Symfony Mailer transport configuration
- 'transportType' => 'email_transport_type',
-
- // SMTP configuration
- 'smtpHost' => 'email_smtp_host',
- 'smtpPort' => 'email_smtp_port',
- 'smtpEncryption' => 'email_smtp_encryption',
- 'smtpUsername' => 'email_smtp_username',
- 'smtpPassword' => 'email_smtp_password',
-
- // SendGrid configuration
- 'sendgridApiKey' => 'email_sendgrid_api_key',
-
- // Mailgun configuration
- 'mailgunApiKey' => 'email_mailgun_api_key',
- 'mailgunDomain' => 'email_mailgun_domain',
-
- // Postmark configuration
- 'postmarkApiKey' => 'email_postmark_api_key',
-
- // Amazon SES configuration
- 'sesAccessKey' => 'email_ses_access_key',
- 'sesSecretKey' => 'email_ses_secret_key',
- 'sesRegion' => 'email_ses_region',
-
- // Mailjet configuration
- 'mailjetApiKey' => 'email_mailjet_api_key',
- 'mailjetSecretKey' => 'email_mailjet_secret_key',
+ 'organizationActivationEnabled' => 'email_org_activation_enabled',
+ 'userCreationEnabled' => 'email_user_creation_enabled',
+ 'userPasswordEnabled' => 'email_user_password_enabled',
+ 'userOrganisationEnabled' => 'email_user_organisation_enabled',
+
+ // Symfony Mailer transport configuration.
+ 'transportType' => 'email_transport_type',
+
+ // SMTP configuration.
+ 'smtpHost' => 'email_smtp_host',
+ 'smtpPort' => 'email_smtp_port',
+ 'smtpEncryption' => 'email_smtp_encryption',
+ 'smtpUsername' => 'email_smtp_username',
+ 'smtpPassword' => 'email_smtp_password',
+
+ // SendGrid configuration.
+ 'sendgridApiKey' => 'email_sendgrid_api_key',
+
+ // Mailgun configuration.
+ 'mailgunApiKey' => 'email_mailgun_api_key',
+ 'mailgunDomain' => 'email_mailgun_domain',
+
+ // Postmark configuration.
+ 'postmarkApiKey' => 'email_postmark_api_key',
+
+ // Amazon SES configuration.
+ 'sesAccessKey' => 'email_ses_access_key',
+ 'sesSecretKey' => 'email_ses_secret_key',
+ 'sesRegion' => 'email_ses_region',
+
+ // Mailjet configuration.
+ 'mailjetApiKey' => 'email_mailjet_api_key',
+ 'mailjetSecretKey' => 'email_mailjet_secret_key',
];
$updatedSettings = [];
foreach ($allowedSettings as $settingKey => $configKey) {
- if (array_key_exists($settingKey, $emailSettings)) {
+ if (array_key_exists($settingKey, $emailSettings) === true) {
$value = $emailSettings[$settingKey];
- // Convert boolean values to strings
- if (is_bool($value)) {
- $value = $value ? 'true' : 'false';
+ // Convert boolean values to strings.
+ if (is_bool($value) === true) {
+ if ($value === true) {
+ $value = 'true';
+ } else {
+ $value = 'false';
+ }
}
$this->config->setValueString($this->_appName, $configKey, (string) $value);
@@ -1756,12 +1954,12 @@ public function updateEmailSettings(array $emailSettings): array
$this->logger->info(
'Email settings updated successfully',
[
- 'updatedKeys' => array_keys($updatedSettings)
+ 'updatedKeys' => array_keys($updatedSettings),
]
);
return $updatedSettings;
- }
+ }//end updateEmailSettings()
/**
* Gets email template content for a specific template
@@ -1772,11 +1970,11 @@ public function updateEmailSettings(array $emailSettings): array
*/
public function getEmailTemplate(string $templateName): string
{
- $configKey = "email_template_{$templateName}";
- $defaultTemplate = $this->getDefaultEmailTemplate($templateName);
+ $configKey = "email_template_{$templateName}";
+ $defaultTemplate = $this->getDefaultEmailTemplate(templateName: $templateName);
return $this->config->getValueString($this->_appName, $configKey, $defaultTemplate);
- }
+ }//end getEmailTemplate()
/**
* Updates email template content
@@ -1795,21 +1993,21 @@ public function updateEmailTemplate(string $templateName, string $templateConten
$this->logger->info(
'Email template updated successfully',
[
- 'templateName' => $templateName
+ 'templateName' => $templateName,
]
);
return true;
} catch (\Exception $e) {
$this->logger->error(
- 'Failed to update email template: ' . $e->getMessage(),
+ 'Failed to update email template: '.$e->getMessage(),
[
- 'templateName' => $templateName
+ 'templateName' => $templateName,
]
);
return false;
- }
- }
+ }//end try
+ }//end updateEmailTemplate()
/**
* Gets default email template content
@@ -1835,7 +2033,7 @@ public function getDefaultEmailTemplate(string $templateName): string
Heeft u vragen? Neem dan contact met ons op.
Met vriendelijke groet,
Het Software Catalogus Team
',
- 'organization_activation' => '
+ 'organization_activation' => '
Uw organisatie is geactiveerd!
Beste {{ organization.name }},
Goed nieuws! Uw organisatie is zojuist geactiveerd in de Software Catalogus.
@@ -1849,7 +2047,7 @@ public function getDefaultEmailTemplate(string $templateName): string
U kunt nu inloggen en gebruik maken van alle beschikbare functionaliteiten.
Met vriendelijke groet,
Het Software Catalogus Team
',
- 'user_creation' => '
+ 'user_creation' => '
Welkom {{ user.name }}!
Beste {{ user.name }},
Er is een gebruikersaccount voor u aangemaakt in de Software Catalogus.
@@ -1863,7 +2061,7 @@ public function getDefaultEmailTemplate(string $templateName): string
Heeft u vragen over uw account? Neem dan contact met ons op.
Met vriendelijke groet,
Het Software Catalogus Team
',
- 'user_password' => '
+ 'user_password' => '
Uw wachtwoord voor de Software Catalogus
Beste {{ user.name }},
Uw wachtwoord voor de Software Catalogus is aangepast.
@@ -1876,11 +2074,11 @@ public function getDefaultEmailTemplate(string $templateName): string
U kunt nu inloggen met uw nieuwe wachtwoord.
We raden u aan om uw wachtwoord te wijzigen na het eerste inloggen.
Met vriendelijke groet,
Het Software Catalogus Team
- '
+ ',
];
return $templates[$templateName] ?? '';
- }
+ }//end getDefaultEmailTemplate()
/**
* Gets available email template variables for a specific template
@@ -1893,34 +2091,34 @@ public function getEmailTemplateVariables(string $templateName): array
{
$variables = [
'organization_registration' => [
- 'organization.name' => 'Organization name',
+ 'organization.name' => 'Organization name',
'organization.beoordeling' => 'Organization status (e.g., Actief)',
- 'organization.type' => 'Organization type (e.g., Leverancier)',
- 'organization.website' => 'Organization website',
+ 'organization.type' => 'Organization type (e.g., Leverancier)',
+ 'organization.website' => 'Organization website',
],
- 'organization_activation' => [
- 'organization.name' => 'Organization name',
+ 'organization_activation' => [
+ 'organization.name' => 'Organization name',
'organization.beoordeling' => 'Organization status (e.g., Actief)',
- 'organization.type' => 'Organization type',
- 'organization.website' => 'Organization website',
+ 'organization.type' => 'Organization type',
+ 'organization.website' => 'Organization website',
],
- 'user_creation' => [
- 'user.name' => 'User display name',
- 'user.email' => 'User email address',
- 'user.username' => 'Username',
+ 'user_creation' => [
+ 'user.name' => 'User display name',
+ 'user.email' => 'User email address',
+ 'user.username' => 'Username',
'user.organization.name' => 'Organization name (if applicable)',
],
- 'user_password' => [
- 'user.name' => 'User display name',
- 'user.email' => 'User email address',
- 'user.username' => 'Username',
- 'user.password' => 'Auto-generated password',
+ 'user_password' => [
+ 'user.name' => 'User display name',
+ 'user.email' => 'User email address',
+ 'user.username' => 'Username',
+ 'user.password' => 'Auto-generated password',
'user.organization.name' => 'Organization name (if applicable)',
- ]
+ ],
];
return $variables[$templateName] ?? [];
- }
+ }//end getEmailTemplateVariables()
/**
* Gets debug information for settings
@@ -1932,7 +2130,7 @@ public function getDebugInfo(): array
$debugInfo = [];
try {
- // Get current configuration values
+ // Get current configuration values.
$debugInfo['configuration'] = [];
$configKeys = [
'amef_organization_source',
@@ -1944,28 +2142,33 @@ public function getDebugInfo(): array
'voorzieningen_contactpersoon_source',
'voorzieningen_contactpersoon_register',
'voorzieningen_contactpersoon_schema',
- 'voorzieningen_register', // Sync service expects this key
+ 'voorzieningen_register',
+ // Sync service expects this key.
'organization_source',
'organization_register',
'organization_schema',
'contact_source',
'contact_register',
- 'contact_schema'
+ 'contact_schema',
];
foreach ($configKeys as $key) {
$value = $this->config->getValueString($this->_appName, $key, '');
- $debugInfo['configuration'][$key] = empty($value) ? '' : $value;
+ if (empty($value) === true) {
+ $debugInfo['configuration'][$key] = '';
+ } else {
+ $debugInfo['configuration'][$key] = $value;
+ }
}
- // Get group configurations
+ // Get group configurations.
$debugInfo['userGroups'] = [
- 'generic' => $this->getGenericUserGroups(),
+ 'generic' => $this->getGenericUserGroups(),
'organizationAdmin' => $this->getOrganizationAdminGroups(),
- 'superUser' => $this->getSuperUserGroups()
+ 'superUser' => $this->getSuperUserGroups(),
];
- // Get email settings (without sensitive data)
+ // Get email settings (without sensitive data).
$emailSettings = $this->getEmailSettings();
unset($emailSettings['smtpPassword']);
unset($emailSettings['sendgridApiKey']);
@@ -1975,14 +2178,14 @@ public function getDebugInfo(): array
unset($emailSettings['mailjetSecretKey']);
$debugInfo['emailSettings'] = $emailSettings;
- // Get OpenRegister status
+ // Get OpenRegister status.
$debugInfo['openRegister'] = [
- 'installed' => $this->isOpenRegisterInstalled(),
- 'enabled' => $this->isOpenRegisterEnabled(),
- 'availableRegisters' => []
+ 'installed' => $this->isOpenRegisterInstalled(),
+ 'enabled' => $this->isOpenRegisterEnabled(),
+ 'availableRegisters' => [],
];
- if ($debugInfo['openRegister']['installed'] && $debugInfo['openRegister']['enabled']) {
+ if ($debugInfo['openRegister']['installed'] === true && $debugInfo['openRegister']['enabled'] === true) {
try {
$registerService = $this->getRegisterService();
$debugInfo['openRegister']['availableRegisters'] = $registerService->findAll();
@@ -1990,13 +2193,12 @@ public function getDebugInfo(): array
$debugInfo['openRegister']['error'] = $e->getMessage();
}
}
-
} catch (\Exception $e) {
$debugInfo['error'] = $e->getMessage();
- }
+ }//end try
return $debugInfo;
- }
+ }//end getDebugInfo()
/**
* Sends a test email
@@ -2006,125 +2208,144 @@ public function getDebugInfo(): array
*
* @return array Result of the test email
*/
- public function sendTestEmail(string $email, array $emailSettings = []): array
+ public function sendTestEmail(string $email, array $emailSettings=[]): array
{
- // Validate email address first (business logic moved from controller)
- if (empty($email)) {
+ // Validate email address first (business logic moved from controller).
+ if (empty($email) === true) {
$this->logger->warning('SoftwareCatalog: Test email request missing email address');
return [
'success' => false,
- 'message' => 'Email address is required'
+ 'message' => 'Email address is required',
];
}
- $this->logger->info('SoftwareCatalog: Starting sendTestEmail process', [
- 'recipient' => $email,
- 'has_email_settings' => !empty($emailSettings)
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: Starting sendTestEmail process',
+ [
+ 'recipient' => $email,
+ 'has_email_settings' => empty($emailSettings) === false,
+ ]
+ );
try {
- // Ensure vendor autoloader is loaded
- include_once __DIR__ . '/../../vendor/autoload.php';
+ // Ensure vendor autoloader is loaded.
+ include_once __DIR__.'/../../vendor/autoload.php';
$this->logger->debug('SoftwareCatalog: Vendor autoloader loaded');
- // Use provided settings or fall back to stored settings
- if (empty($emailSettings)) {
+ // Use provided settings or fall back to stored settings.
+ if (empty($emailSettings) === true) {
$emailSettings = $this->getEmailSettings();
$this->logger->info('SoftwareCatalog: Loaded email settings from storage');
} else {
$this->logger->info('SoftwareCatalog: Using provided email settings');
}
- // Log the email configuration (without sensitive data)
- $this->logger->info('SoftwareCatalog: Email configuration', [
- 'enabled' => $emailSettings['enabled'] ?? false,
- 'transport_type' => $emailSettings['transportType'] ?? 'unknown',
- 'sender_email' => $emailSettings['senderEmail'] ?? 'not set',
- 'sender_name' => $emailSettings['senderName'] ?? 'not set',
- 'has_mailjet_api_key' => !empty($emailSettings['mailjetApiKey']),
- 'has_mailjet_secret_key' => !empty($emailSettings['mailjetSecretKey']),
- ]);
-
- // Check if email is enabled
- if (!($emailSettings['enabled'] ?? false)) {
+ // Log the email configuration (without sensitive data).
+ $this->logger->info(
+ 'SoftwareCatalog: Email configuration',
+ [
+ 'enabled' => $emailSettings['enabled'] ?? false,
+ 'transport_type' => $emailSettings['transportType'] ?? 'unknown',
+ 'sender_email' => $emailSettings['senderEmail'] ?? 'not set',
+ 'sender_name' => $emailSettings['senderName'] ?? 'not set',
+ 'has_mailjet_api_key' => empty($emailSettings['mailjetApiKey']) === false,
+ 'has_mailjet_secret_key' => empty($emailSettings['mailjetSecretKey']) === false,
+ ]
+ );
+
+ // Check if email is enabled.
+ if (($emailSettings['enabled'] ?? false) === false) {
$this->logger->warning('SoftwareCatalog: Email notifications are disabled');
return [
'success' => false,
- 'message' => 'Email notifications are disabled'
+ 'message' => 'Email notifications are disabled',
];
}
- // Use test receiver override if configured
+ // Use test receiver override if configured.
$recipient = $emailSettings['testReceiverOverride'] ?? $email;
- $this->logger->info('SoftwareCatalog: Final recipient determined', [
- 'original_recipient' => $email,
- 'final_recipient' => $recipient,
- 'using_override' => !empty($emailSettings['testReceiverOverride'])
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: Final recipient determined',
+ [
+ 'original_recipient' => $email,
+ 'final_recipient' => $recipient,
+ 'using_override' => empty($emailSettings['testReceiverOverride']) === false,
+ ]
+ );
- // Create transport based on configuration
+ // Create transport based on configuration.
$this->logger->info('SoftwareCatalog: Creating email transport');
- $transport = $this->createEmailTransport($emailSettings);
+ $transport = $this->createEmailTransport(emailSettings: $emailSettings);
$this->logger->info('SoftwareCatalog: Email transport created successfully');
$mailer = new Mailer($transport);
$this->logger->info('SoftwareCatalog: Mailer instance created');
- // Create test email
- $senderEmail = $emailSettings['senderEmail'] ?? 'noreply@softwarecatalogus.nl';
- $senderName = $emailSettings['senderName'] ?? 'Software Catalogus';
+ // Create test email.
+ $senderEmail = $emailSettings['senderEmail'] ?? 'noreply@softwarecatalogus.nl';
+ $senderName = $emailSettings['senderName'] ?? 'Software Catalogus';
$transportType = $emailSettings['transportType'] ?? 'smtp';
- $this->logger->info('SoftwareCatalog: Creating email message', [
- 'sender_email' => $senderEmail,
- 'sender_name' => $senderName,
- 'transport_type' => $transportType,
- 'recipient' => $recipient
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: Creating email message',
+ [
+ 'sender_email' => $senderEmail,
+ 'sender_name' => $senderName,
+ 'transport_type' => $transportType,
+ 'recipient' => $recipient,
+ ]
+ );
$email = (new Email())
->from(new Address($senderEmail, $senderName))
->to($recipient)
->subject('Software Catalogus - Test Email')
- ->html('
+ ->html(
+ '
Test Email - Software Catalogus
Dit is een test email van de Software Catalogus.
Als u deze email ontvangt, werkt het email systeem correct.
- Transport Type: ' . htmlspecialchars($transportType) . '
- Datum: ' . date('Y-m-d H:i:s') . '
+ Transport Type: '.htmlspecialchars($transportType).'
+ Datum: '.date('Y-m-d H:i:s').'
Met vriendelijke groet,
Het Software Catalogus Team
- ');
+ '
+ );
$this->logger->info('SoftwareCatalog: Email message created, attempting to send');
- // Send the email
+ // Send the email.
$mailer->send($email);
- $this->logger->info('SoftwareCatalog: Email sent successfully via Symfony Mailer', [
- 'recipient' => $recipient,
- 'transport' => $transportType,
- 'sender' => $senderEmail
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: Email sent successfully via Symfony Mailer',
+ [
+ 'recipient' => $recipient,
+ 'transport' => $transportType,
+ 'sender' => $senderEmail,
+ ]
+ );
return [
'success' => true,
- 'message' => "Test email sent successfully to {$recipient} via {$transportType}"
+ 'message' => "Test email sent successfully to {$recipient} via {$transportType}",
];
-
} catch (\Exception $e) {
- $this->logger->error('SoftwareCatalog: Failed to send test email', [
- 'recipient' => $email,
- 'exception_class' => get_class($e),
- 'exception_message' => $e->getMessage(),
- 'exception_code' => $e->getCode(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'SoftwareCatalog: Failed to send test email',
+ [
+ 'recipient' => $email,
+ 'exception_class' => get_class($e),
+ 'exception_message' => $e->getMessage(),
+ 'exception_code' => $e->getCode(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to send test email: ' . $e->getMessage()
+ 'message' => 'Failed to send test email: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end sendTestEmail()
/**
* Test email connection without sending an actual email
@@ -2133,96 +2354,108 @@ public function sendTestEmail(string $email, array $emailSettings = []): array
*
* @return array Result of the connection test
*/
- public function testEmailConnection(array $emailSettings = []): array
+ public function testEmailConnection(array $emailSettings=[]): array
{
- $this->logger->info('SoftwareCatalog: Starting email connection test', [
- 'has_email_settings' => !empty($emailSettings)
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: Starting email connection test',
+ [
+ 'has_email_settings' => empty($emailSettings) === false,
+ ]
+ );
try {
- // Ensure vendor autoloader is loaded
- include_once __DIR__ . '/../../vendor/autoload.php';
+ // Ensure vendor autoloader is loaded.
+ include_once __DIR__.'/../../vendor/autoload.php';
$this->logger->debug('SoftwareCatalog: Vendor autoloader loaded');
- // Use provided settings or fall back to stored settings
- if (empty($emailSettings)) {
+ // Use provided settings or fall back to stored settings.
+ if (empty($emailSettings) === true) {
$emailSettings = $this->getEmailSettings();
$this->logger->info('SoftwareCatalog: Loaded email settings from storage');
} else {
$this->logger->info('SoftwareCatalog: Using provided email settings');
}
- // Log the email configuration (without sensitive data)
- $this->logger->info('SoftwareCatalog: Email configuration for connection test', [
- 'enabled' => $emailSettings['enabled'] ?? false,
- 'transport_type' => $emailSettings['transportType'] ?? 'unknown',
- 'sender_email' => $emailSettings['senderEmail'] ?? 'not set',
- 'sender_name' => $emailSettings['senderName'] ?? 'not set',
- 'has_credentials' => $this->hasValidCredentials($emailSettings)
- ]);
-
- // Check if email is enabled
- if (!($emailSettings['enabled'] ?? false)) {
+ // Log the email configuration (without sensitive data).
+ $this->logger->info(
+ 'SoftwareCatalog: Email configuration for connection test',
+ [
+ 'enabled' => $emailSettings['enabled'] ?? false,
+ 'transport_type' => $emailSettings['transportType'] ?? 'unknown',
+ 'sender_email' => $emailSettings['senderEmail'] ?? 'not set',
+ 'sender_name' => $emailSettings['senderName'] ?? 'not set',
+ 'has_credentials' => $this->hasValidCredentials(emailSettings: $emailSettings),
+ ]
+ );
+
+ // Check if email is enabled.
+ if (($emailSettings['enabled'] ?? false) === false) {
$this->logger->warning('SoftwareCatalog: Email notifications are disabled');
return [
'success' => false,
- 'message' => 'Email notifications are disabled'
+ 'message' => 'Email notifications are disabled',
];
}
- // Validate basic settings
+ // Validate basic settings.
$transportType = $emailSettings['transportType'] ?? 'smtp';
- $senderEmail = $emailSettings['senderEmail'] ?? '';
+ $senderEmail = $emailSettings['senderEmail'] ?? '';
- if (empty($senderEmail)) {
+ if (empty($senderEmail) === true) {
return [
'success' => false,
- 'message' => 'Sender email address is required'
+ 'message' => 'Sender email address is required',
];
}
- // Create transport based on configuration (this tests the connection)
+ // Create transport based on configuration (this tests the connection).
$this->logger->info('SoftwareCatalog: Creating email transport for connection test');
- $transport = $this->createEmailTransport($emailSettings);
+ $transport = $this->createEmailTransport(emailSettings: $emailSettings);
$this->logger->info('SoftwareCatalog: Email transport created successfully');
- // Test the connection by creating a mailer instance
+ // Test the connection by creating a mailer instance.
$mailer = new Mailer($transport);
$this->logger->info('SoftwareCatalog: Mailer instance created for connection test');
- // For some transports, we can test the connection more directly
- $connectionDetails = $this->getConnectionDetails($emailSettings);
+ // For some transports, we can test the connection more directly.
+ $connectionDetails = $this->getConnectionDetails(emailSettings: $emailSettings);
- $this->logger->info('SoftwareCatalog: Email connection test completed successfully', [
- 'transport' => $transportType,
- 'sender' => $senderEmail
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: Email connection test completed successfully',
+ [
+ 'transport' => $transportType,
+ 'sender' => $senderEmail,
+ ]
+ );
return [
'success' => true,
'message' => "Email connection test successful for {$transportType}",
- 'details' => $connectionDetails
+ 'details' => $connectionDetails,
];
-
} catch (\Exception $e) {
- $this->logger->error('SoftwareCatalog: Email connection test failed', [
- 'exception_class' => get_class($e),
- 'exception_message' => $e->getMessage(),
- 'exception_code' => $e->getCode(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'SoftwareCatalog: Email connection test failed',
+ [
+ 'exception_class' => get_class($e),
+ 'exception_message' => $e->getMessage(),
+ 'exception_code' => $e->getCode(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Email connection test failed: ' . $e->getMessage()
+ 'message' => 'Email connection test failed: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end testEmailConnection()
/**
* Check if email settings have valid credentials for the transport type
*
- * @param array $emailSettings Email settings
- * @return bool True if credentials are present
+ * @param array $emailSettings Email settings.
+ *
+ * @return bool True if credentials are present.
*/
private function hasValidCredentials(array $emailSettings): bool
{
@@ -2230,27 +2463,28 @@ private function hasValidCredentials(array $emailSettings): bool
switch ($transportType) {
case 'smtp':
- return !empty($emailSettings['smtpHost']) && !empty($emailSettings['smtpPort']);
+ return empty($emailSettings['smtpHost']) === false && empty($emailSettings['smtpPort']) === false;
case 'mailjet':
- return !empty($emailSettings['mailjetApiKey']) && !empty($emailSettings['mailjetSecretKey']);
+ return empty($emailSettings['mailjetApiKey']) === false && empty($emailSettings['mailjetSecretKey']) === false;
case 'sendgrid':
- return !empty($emailSettings['sendgridApiKey']);
+ return empty($emailSettings['sendgridApiKey']) === false;
case 'mailgun':
- return !empty($emailSettings['mailgunApiKey']) && !empty($emailSettings['mailgunDomain']);
+ return empty($emailSettings['mailgunApiKey']) === false && empty($emailSettings['mailgunDomain']) === false;
case 'postmark':
- return !empty($emailSettings['postmarkApiKey']);
+ return empty($emailSettings['postmarkApiKey']) === false;
case 'ses':
- return !empty($emailSettings['sesAccessKey']) && !empty($emailSettings['sesSecretKey']);
+ return empty($emailSettings['sesAccessKey']) === false && empty($emailSettings['sesSecretKey']) === false;
default:
return false;
}
- }
+ }//end hasValidCredentials()
/**
* Get connection details for the email transport
*
- * @param array $emailSettings Email settings
- * @return array Connection details
+ * @param array $emailSettings Email settings.
+ *
+ * @return array Connection details.
*/
private function getConnectionDetails(array $emailSettings): array
{
@@ -2258,100 +2492,120 @@ private function getConnectionDetails(array $emailSettings): array
switch ($transportType) {
case 'smtp':
+ if (empty($emailSettings['smtpUsername']) === false) {
+ $usernameValue = '***';
+ } else {
+ $usernameValue = 'none';
+ }
return [
- 'type' => 'SMTP',
- 'host' => $emailSettings['smtpHost'] ?? '',
- 'port' => $emailSettings['smtpPort'] ?? '',
+ 'type' => 'SMTP',
+ 'host' => $emailSettings['smtpHost'] ?? '',
+ 'port' => $emailSettings['smtpPort'] ?? '',
'encryption' => $emailSettings['smtpEncryption'] ?? 'none',
- 'username' => !empty($emailSettings['smtpUsername']) ? '***' : 'none'
+ 'username' => $usernameValue,
];
case 'mailjet':
return [
- 'type' => 'Mailjet API',
- 'has_api_key' => !empty($emailSettings['mailjetApiKey']),
- 'has_secret_key' => !empty($emailSettings['mailjetSecretKey'])
+ 'type' => 'Mailjet API',
+ 'has_api_key' => empty($emailSettings['mailjetApiKey']) === false,
+ 'has_secret_key' => empty($emailSettings['mailjetSecretKey']) === false,
];
case 'sendgrid':
return [
- 'type' => 'SendGrid API',
- 'has_api_key' => !empty($emailSettings['sendgridApiKey'])
+ 'type' => 'SendGrid API',
+ 'has_api_key' => empty($emailSettings['sendgridApiKey']) === false,
];
case 'mailgun':
return [
- 'type' => 'Mailgun API',
- 'has_api_key' => !empty($emailSettings['mailgunApiKey']),
- 'domain' => $emailSettings['mailgunDomain'] ?? ''
+ 'type' => 'Mailgun API',
+ 'has_api_key' => empty($emailSettings['mailgunApiKey']) === false,
+ 'domain' => $emailSettings['mailgunDomain'] ?? '',
];
case 'postmark':
return [
- 'type' => 'Postmark API',
- 'has_api_key' => !empty($emailSettings['postmarkApiKey'])
+ 'type' => 'Postmark API',
+ 'has_api_key' => empty($emailSettings['postmarkApiKey']) === false,
];
case 'ses':
return [
- 'type' => 'Amazon SES',
- 'has_access_key' => !empty($emailSettings['sesAccessKey']),
- 'has_secret_key' => !empty($emailSettings['sesSecretKey']),
- 'region' => $emailSettings['sesRegion'] ?? 'us-east-1'
+ 'type' => 'Amazon SES',
+ 'has_access_key' => empty($emailSettings['sesAccessKey']) === false,
+ 'has_secret_key' => empty($emailSettings['sesSecretKey']) === false,
+ 'region' => $emailSettings['sesRegion'] ?? 'us-east-1',
];
default:
return ['type' => $transportType];
- }
- }
+ }//end switch
+ }//end getConnectionDetails()
/**
* Creates an email transport based on configuration
*
- * @param array $emailSettings Email settings
+ * @param array $emailSettings Email settings.
+ *
* @return \Symfony\Component\Mailer\Transport\TransportInterface
- * @throws \Exception If transport configuration is invalid
+ *
+ * @throws \Exception If transport configuration is invalid.
*/
private function createEmailTransport(array $emailSettings): \Symfony\Component\Mailer\Transport\TransportInterface
{
$transportType = $emailSettings['transportType'] ?? 'smtp';
- $this->logger->info('SoftwareCatalog: Creating transport', [
- 'transport_type' => $transportType
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: Creating transport',
+ [
+ 'transport_type' => $transportType,
+ ]
+ );
switch ($transportType) {
case 'mailjet':
$this->logger->info('SoftwareCatalog: Creating Mailjet transport');
- return $this->createMailjetTransport($emailSettings);
+ return $this->createMailjetTransport(settings: $emailSettings);
case 'smtp':
$this->logger->info('SoftwareCatalog: Creating SMTP transport');
- return $this->createSmtpTransport($emailSettings);
+ return $this->createSmtpTransport(settings: $emailSettings);
default:
- $this->logger->error('SoftwareCatalog: Unsupported transport type', [
- 'transport_type' => $transportType
- ]);
+ $this->logger->error(
+ 'SoftwareCatalog: Unsupported transport type',
+ [
+ 'transport_type' => $transportType,
+ ]
+ );
throw new \InvalidArgumentException("Unsupported transport type: {$transportType}");
}
- }
+ }//end createEmailTransport()
/**
* Creates a Mailjet transport
*
- * @param array $settings Email settings
+ * @param array $settings Email settings.
+ *
* @return \Symfony\Component\Mailer\Transport\TransportInterface
*/
private function createMailjetTransport(array $settings): \Symfony\Component\Mailer\Transport\TransportInterface
{
- $apiKey = $settings['mailjetApiKey'] ?? '';
+ $apiKey = $settings['mailjetApiKey'] ?? '';
$secretKey = $settings['mailjetSecretKey'] ?? '';
- $this->logger->info('SoftwareCatalog: Mailjet transport configuration', [
- 'has_api_key' => !empty($apiKey),
- 'api_key_length' => strlen($apiKey),
- 'has_secret_key' => !empty($secretKey),
- 'secret_key_length' => strlen($secretKey)
- ]);
-
- if (empty($apiKey) || empty($secretKey)) {
- $this->logger->error('SoftwareCatalog: Mailjet API key and secret key are required', [
- 'api_key_empty' => empty($apiKey),
- 'secret_key_empty' => empty($secretKey)
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: Mailjet transport configuration',
+ [
+ 'has_api_key' => empty($apiKey) === false,
+ 'api_key_length' => strlen($apiKey),
+ 'has_secret_key' => empty($secretKey) === false,
+ 'secret_key_length' => strlen($secretKey),
+ ]
+ );
+
+ if (empty($apiKey) === true || empty($secretKey) === true) {
+ $this->logger->error(
+ 'SoftwareCatalog: Mailjet API key and secret key are required',
+ [
+ 'api_key_empty' => empty($apiKey) === true,
+ 'secret_key_empty' => empty($secretKey) === true,
+ ]
+ );
throw new \InvalidArgumentException('Mailjet API key and secret key are required');
}
@@ -2361,46 +2615,59 @@ private function createMailjetTransport(array $settings): \Symfony\Component\Mai
urlencode($secretKey)
);
- $this->logger->info('SoftwareCatalog: Creating Mailjet transport with DSN', [
- 'dsn_pattern' => 'mailjet+api://***:***@default'
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: Creating Mailjet transport with DSN',
+ [
+ 'dsn_pattern' => 'mailjet+api://***:***@default',
+ ]
+ );
try {
$transport = Transport::fromDsn($dsn);
- $this->logger->info('SoftwareCatalog: Mailjet transport created successfully', [
- 'transport_class' => get_class($transport)
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: Mailjet transport created successfully',
+ [
+ 'transport_class' => get_class($transport),
+ ]
+ );
return $transport;
} catch (\Exception $e) {
- $this->logger->error('SoftwareCatalog: Failed to create Mailjet transport', [
- 'exception_class' => get_class($e),
- 'exception_message' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'SoftwareCatalog: Failed to create Mailjet transport',
+ [
+ 'exception_class' => get_class($e),
+ 'exception_message' => $e->getMessage(),
+ ]
+ );
throw $e;
}
- }
+ }//end createMailjetTransport()
/**
* Creates an SMTP transport
*
- * @param array $settings Email settings
+ * @param array $settings Email settings.
+ *
* @return \Symfony\Component\Mailer\Transport\TransportInterface
*/
private function createSmtpTransport(array $settings): \Symfony\Component\Mailer\Transport\TransportInterface
{
- $host = $settings['smtpHost'] ?? 'localhost';
- $port = $settings['smtpPort'] ?? 587;
+ $host = $settings['smtpHost'] ?? 'localhost';
+ $port = $settings['smtpPort'] ?? 587;
$encryption = $settings['smtpEncryption'] ?? 'tls';
- $username = $settings['smtpUsername'] ?? '';
- $password = $settings['smtpPassword'] ?? '';
+ $username = $settings['smtpUsername'] ?? '';
+ $password = $settings['smtpPassword'] ?? '';
- $this->logger->info('SoftwareCatalog: SMTP transport configuration', [
- 'host' => $host,
- 'port' => $port,
- 'encryption' => $encryption,
- 'has_username' => !empty($username),
- 'has_password' => !empty($password)
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: SMTP transport configuration',
+ [
+ 'host' => $host,
+ 'port' => $port,
+ 'encryption' => $encryption,
+ 'has_username' => empty($username) === false,
+ 'has_password' => empty($password) === false,
+ ]
+ );
$dsn = sprintf(
'smtp://%s:%s@%s:%d',
@@ -2410,28 +2677,45 @@ private function createSmtpTransport(array $settings): \Symfony\Component\Mailer
$port
);
- if ($encryption && $encryption !== 'none') {
- $dsn .= '?encryption=' . $encryption;
+ if ($encryption !== false && $encryption !== 'none') {
+ $dsn .= '?encryption='.$encryption;
+ }
+
+ if (empty($encryption) === false && $encryption !== 'none') {
+ $encSuffix = '?encryption='.$encryption;
+ } else {
+ $encSuffix = '';
}
- $this->logger->info('SoftwareCatalog: Creating SMTP transport with DSN', [
- 'dsn_pattern' => sprintf('smtp://***:***@%s:%d%s', $host, $port, $encryption && $encryption !== 'none' ? '?encryption=' . $encryption : '')
- ]);
+ $dsnPattern = sprintf('smtp://***:***@%s:%d%s', $host, $port, $encSuffix);
+
+ $this->logger->info(
+ 'SoftwareCatalog: Creating SMTP transport with DSN',
+ [
+ 'dsn_pattern' => $dsnPattern,
+ ]
+ );
try {
$transport = Transport::fromDsn($dsn);
- $this->logger->info('SoftwareCatalog: SMTP transport created successfully', [
- 'transport_class' => get_class($transport)
- ]);
+ $this->logger->info(
+ 'SoftwareCatalog: SMTP transport created successfully',
+ [
+ 'transport_class' => get_class($transport),
+ ]
+ );
return $transport;
} catch (\Exception $e) {
- $this->logger->error('SoftwareCatalog: Failed to create SMTP transport', [
- 'exception_class' => get_class($e),
- 'exception_message' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'SoftwareCatalog: Failed to create SMTP transport',
+ [
+ 'exception_class' => get_class($e),
+ 'exception_message' => $e->getMessage(),
+ ]
+ );
throw $e;
}
- }
+ }//end createSmtpTransport()
/**
* Check if settings should be loaded based on version comparison.
@@ -2444,50 +2728,61 @@ private function createSmtpTransport(array $settings): \Symfony\Component\Mailer
private function shouldLoadSettings(): bool
{
try {
- // Get the current app version
+ // Get the current app version.
$currentAppVersion = $this->appManager->getAppVersion(\OCA\SoftwareCatalog\AppInfo\Application::APP_ID);
- $this->logger->info('SettingsService: Checking if settings should be loaded', [
- 'current_app_version' => $currentAppVersion
- ]);
+ $this->logger->info(
+ 'SettingsService: Checking if settings should be loaded',
+ [
+ 'current_app_version' => $currentAppVersion,
+ ]
+ );
- // Get the configuration service to check stored version
+ // Get the configuration service to check stored version.
$configurationService = $this->getConfigurationService();
- $storedVersion = $configurationService->getConfiguredAppVersion(\OCA\SoftwareCatalog\AppInfo\Application::APP_ID);
+ $storedVersion = $configurationService->getConfiguredAppVersion(\OCA\SoftwareCatalog\AppInfo\Application::APP_ID);
- $this->logger->info('SettingsService: Version comparison details', [
- 'current_app_version' => $currentAppVersion,
- 'stored_config_version' => $storedVersion,
- 'stored_version_is_null' => $storedVersion === null
- ]);
+ $this->logger->info(
+ 'SettingsService: Version comparison details',
+ [
+ 'current_app_version' => $currentAppVersion,
+ 'stored_config_version' => $storedVersion,
+ 'stored_version_is_null' => $storedVersion === null,
+ ]
+ );
- // If no stored version exists, we need to load settings
+ // If no stored version exists, we need to load settings.
if ($storedVersion === null) {
$this->logger->info('SettingsService: No stored version found, settings should be loaded');
return true;
}
- // Compare versions using semantic versioning
- // Load settings if current version is newer than stored version
+ // Compare versions using semantic versioning.
+ // Load settings if current version is newer than stored version.
$shouldLoad = version_compare($currentAppVersion, $storedVersion, '>');
- $this->logger->info('SettingsService: Version comparison result', [
- 'current_version' => $currentAppVersion,
- 'stored_version' => $storedVersion,
- 'should_load' => $shouldLoad,
- 'version_compare_result' => version_compare($currentAppVersion, $storedVersion)
- ]);
+ $this->logger->info(
+ 'SettingsService: Version comparison result',
+ [
+ 'current_version' => $currentAppVersion,
+ 'stored_version' => $storedVersion,
+ 'should_load' => $shouldLoad,
+ 'version_compare_result' => version_compare($currentAppVersion, $storedVersion),
+ ]
+ );
return $shouldLoad;
-
} catch (\Exception $e) {
- // If we can't determine versions, err on the side of loading settings
- $this->logger->warning('Failed to check if settings should be loaded: ' . $e->getMessage(), [
- 'exception' => $e
- ]);
+ // If we can't determine versions, err on the side of loading settings.
+ $this->logger->warning(
+ 'Failed to check if settings should be loaded: '.$e->getMessage(),
+ [
+ 'exception' => $e,
+ ]
+ );
return true;
- }
- }
+ }//end try
+ }//end shouldLoadSettings()
/**
* Get version information for the app and configuration.
@@ -2501,60 +2796,75 @@ private function shouldLoadSettings(): bool
public function getVersionInfo(): array
{
try {
- // Get the current app version
+ // Get the current app version.
$currentAppVersion = $this->appManager->getAppVersion(\OCA\SoftwareCatalog\AppInfo\Application::APP_ID);
- $this->logger->debug('SettingsService: Getting version information', [
- 'current_app_version' => $currentAppVersion
- ]);
+ $this->logger->debug(
+ 'SettingsService: Getting version information',
+ [
+ 'current_app_version' => $currentAppVersion,
+ ]
+ );
- // Get the configuration service to check stored version
+ // Get the configuration service to check stored version.
$configurationService = $this->getConfigurationService();
- $storedConfigVersion = null;
+ $storedConfigVersion = null;
try {
$storedConfigVersion = $configurationService->getConfiguredAppVersion(\OCA\SoftwareCatalog\AppInfo\Application::APP_ID);
} catch (\Exception $e) {
- $this->logger->warning('SettingsService: Could not retrieve stored configuration version', [
- 'exception_message' => $e->getMessage()
- ]);
- // Continue with null stored version
+ $this->logger->warning(
+ 'SettingsService: Could not retrieve stored configuration version',
+ [
+ 'exception_message' => $e->getMessage(),
+ ]
+ );
+ // Continue with null stored version.
}
- // Determine if versions match
+ // Determine if versions match.
$versionsMatch = $storedConfigVersion !== null &&
version_compare($currentAppVersion, $storedConfigVersion, '=');
$needsUpdate = $storedConfigVersion === null ||
version_compare($currentAppVersion, $storedConfigVersion, '>');
- // Check OpenRegister status
+ // Check OpenRegister status.
$openRegisterInstalled = $this->isOpenRegisterInstalled();
- $openRegisterEnabled = $openRegisterInstalled && $this->isOpenRegisterEnabled();
+ $openRegisterEnabled = $openRegisterInstalled && $this->isOpenRegisterEnabled();
+
+ if ($storedConfigVersion !== null) {
+ $versionComparisonValue = version_compare($currentAppVersion, $storedConfigVersion);
+ } else {
+ $versionComparisonValue = null;
+ }
$versionInfo = [
- 'appName' => 'SoftwareCatalog',
- 'appVersion' => $currentAppVersion,
- 'configuredVersion' => $storedConfigVersion,
- 'versionsMatch' => $versionsMatch,
- 'needsUpdate' => $needsUpdate,
- 'versionComparison' => $storedConfigVersion !== null ? version_compare($currentAppVersion, $storedConfigVersion) : null,
- 'isFullyConfigured' => $this->isFullyConfigured(),
- 'autoConfigCompleted' => $this->config->getValueString($this->_appName, 'auto_config_completed', 'false') === 'true',
+ 'appName' => 'SoftwareCatalog',
+ 'appVersion' => $currentAppVersion,
+ 'configuredVersion' => $storedConfigVersion,
+ 'versionsMatch' => $versionsMatch,
+ 'needsUpdate' => $needsUpdate,
+ 'versionComparison' => $versionComparisonValue,
+ 'isFullyConfigured' => $this->isFullyConfigured(),
+ 'autoConfigCompleted' => $this->config->getValueString($this->_appName, 'auto_config_completed', 'false') === 'true',
'openRegisterInstalled' => $openRegisterInstalled,
- 'openRegisterEnabled' => $openRegisterEnabled
+ 'openRegisterEnabled' => $openRegisterEnabled,
];
$this->logger->info('SettingsService: Version information compiled', $versionInfo);
return $versionInfo;
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to get version information', [
- 'exception' => $e
- ]);
- throw new \RuntimeException('Failed to get version information: ' . $e->getMessage());
- }
- }
+ $this->logger->error(
+ 'SettingsService: Failed to get version information',
+ [
+ 'exception' => $e,
+ ]
+ );
+ throw new \RuntimeException('Failed to get version information: '.$e->getMessage());
+ }//end try
+ }//end getVersionInfo()
/**
* Forces a complete configuration update regardless of version checks
@@ -2569,63 +2879,74 @@ public function forceUpdate(): array
try {
$this->logger->info('SettingsService: Starting force update');
- // Reset auto-configuration flag
+ // Reset auto-configuration flag.
$this->config->setValueString($this->_appName, 'auto_config_completed', 'false');
- // Perform forced import
- $importResult = $this->manualImport(true);
+ // Perform forced import.
+ $importResult = $this->manualImport(forceImport: true);
- if (!$importResult['success']) {
+ if ($importResult['success'] === false) {
return [
- 'success' => false,
- 'message' => 'Force update failed during import: ' . ($importResult['message'] ?? 'Unknown error'),
- 'importResult' => $importResult
+ 'success' => false,
+ 'message' => 'Force update failed during import: '.($importResult['message'] ?? 'Unknown error'),
+ 'importResult' => $importResult,
];
}
- // Verify configuration after force update
- $finalVersionInfo = $this->getVersionInfo();
+ // Verify configuration after force update.
+ $finalVersionInfo = $this->getVersionInfo();
$finalConfigStatus = $this->getConfigurationStatus();
- // For force update, if import succeeded, consider it successful
- // Version matching is less critical since we forced the update
- $success = $importResult['success'] && ($finalVersionInfo['isFullyConfigured'] || $finalVersionInfo['versionsMatch']);
+ // For force update, if import succeeded, consider it successful.
+ // Version matching is less critical since we forced the update.
+ $success = $importResult['success'] && ($finalVersionInfo['isFullyConfigured'] !== false || $finalVersionInfo['versionsMatch'] === true);
+
+ $this->logger->info(
+ 'SettingsService: Force update completed',
+ [
+ 'success' => $success,
+ 'import_success' => $importResult['success'],
+ 'final_version_info' => $finalVersionInfo,
+ 'final_config_status' => $finalConfigStatus,
+ ]
+ );
- $this->logger->info('SettingsService: Force update completed', [
- 'success' => $success,
- 'import_success' => $importResult['success'],
- 'final_version_info' => $finalVersionInfo,
- 'final_config_status' => $finalConfigStatus
- ]);
+ // Return concise response to avoid serialization issues with large nested structures.
+ if ($success === true) {
+ $messageValue = 'Force update completed successfully';
+ } else {
+ $messageValue = 'Force update completed but configuration needs attention';
+ }
- // Return concise response to avoid serialization issues with large nested structures
return [
- 'success' => $success,
- 'message' => $success ? 'Force update completed successfully' : 'Force update completed but configuration needs attention',
- 'importSuccess' => $importResult['success'] ?? false,
- 'importMessage' => $importResult['message'] ?? '',
- 'finalVersionInfo' => [
- 'appVersion' => $finalVersionInfo['appVersion'] ?? null,
+ 'success' => $success,
+ 'message' => $messageValue,
+ 'importSuccess' => $importResult['success'] ?? false,
+ 'importMessage' => $importResult['message'] ?? '',
+ 'finalVersionInfo' => [
+ 'appVersion' => $finalVersionInfo['appVersion'] ?? null,
'configuredVersion' => $finalVersionInfo['configuredVersion'] ?? null,
- 'versionsMatch' => $finalVersionInfo['versionsMatch'] ?? false,
- 'needsUpdate' => $finalVersionInfo['needsUpdate'] ?? false,
- 'isFullyConfigured' => $finalVersionInfo['isFullyConfigured'] ?? false
+ 'versionsMatch' => $finalVersionInfo['versionsMatch'] ?? false,
+ 'needsUpdate' => $finalVersionInfo['needsUpdate'] ?? false,
+ 'isFullyConfigured' => $finalVersionInfo['isFullyConfigured'] ?? false,
],
- 'finalConfigStatus' => $finalConfigStatus
+ 'finalConfigStatus' => $finalConfigStatus,
];
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Force update failed', [
- 'exception_message' => $e->getMessage(),
- 'exception' => $e
- ]);
+ $this->logger->error(
+ 'SettingsService: Force update failed',
+ [
+ 'exception_message' => $e->getMessage(),
+ 'exception' => $e,
+ ]
+ );
return [
'success' => false,
- 'message' => 'Force update failed: ' . $e->getMessage(),
- 'error' => $e->getMessage()
+ 'message' => 'Force update failed: '.$e->getMessage(),
+ 'error' => $e->getMessage(),
];
- }
- }
+ }//end try
+ }//end forceUpdate()
/**
* Resets the auto-configuration to allow it to run again
@@ -2637,20 +2958,23 @@ public function forceUpdate(): array
*
* @return array The reset results
*/
- public function resetAutoConfiguration(bool $resetConfiguration = false): array
+ public function resetAutoConfiguration(bool $resetConfiguration=false): array
{
try {
- $this->logger->info('Resetting auto-configuration', [
- 'reset_configuration' => $resetConfiguration
- ]);
+ $this->logger->info(
+ 'Resetting auto-configuration',
+ [
+ 'reset_configuration' => $resetConfiguration,
+ ]
+ );
- // Reset the auto-configuration completion flag
+ // Reset the auto-configuration completion flag.
$this->config->setValueString($this->_appName, 'auto_config_completed', 'false');
$resetItems = ['auto_config_completed_flag'];
- if ($resetConfiguration) {
- // Reset schema and register configurations
+ if (empty($resetConfiguration) === false) {
+ // Reset schema and register configurations.
$configKeysToReset = [
'voorzieningen_organisatie_source',
'voorzieningen_organisatie_register',
@@ -2663,7 +2987,7 @@ public function resetAutoConfiguration(bool $resetConfiguration = false): array
'organization_schema',
'contact_source',
'contact_register',
- 'contact_schema'
+ 'contact_schema',
];
foreach ($configKeysToReset as $key) {
@@ -2671,27 +2995,29 @@ public function resetAutoConfiguration(bool $resetConfiguration = false): array
}
$resetItems[] = 'schema_register_configurations';
- }
+ }//end if
- $this->logger->info('Auto-configuration reset completed', [
- 'reset_items' => $resetItems
- ]);
+ $this->logger->info(
+ 'Auto-configuration reset completed',
+ [
+ 'reset_items' => $resetItems,
+ ]
+ );
return [
- 'success' => true,
- 'message' => 'Auto-configuration reset successfully',
- 'reset_items' => $resetItems
+ 'success' => true,
+ 'message' => 'Auto-configuration reset successfully',
+ 'reset_items' => $resetItems,
];
-
} catch (\Exception $e) {
- $this->logger->error('Failed to reset auto-configuration: ' . $e->getMessage());
+ $this->logger->error('Failed to reset auto-configuration: '.$e->getMessage());
return [
'success' => false,
- 'message' => 'Failed to reset auto-configuration: ' . $e->getMessage(),
- 'error' => $e->getMessage()
+ 'message' => 'Failed to reset auto-configuration: '.$e->getMessage(),
+ 'error' => $e->getMessage(),
];
- }
- }
+ }//end try
+ }//end resetAutoConfiguration()
/**
* Manually trigger configuration import from JSON.
@@ -2703,103 +3029,127 @@ public function resetAutoConfiguration(bool $resetConfiguration = false): array
*
* @return array The import results with success/error information.
*/
- public function manualImport(bool $forceImport = false): array
+ public function manualImport(bool $forceImport=false): array
{
try {
- $this->logger->info('SettingsService: Starting manual import', [
- 'force_import' => $forceImport
- ]);
+ $this->logger->info(
+ 'SettingsService: Starting manual import',
+ [
+ 'force_import' => $forceImport,
+ ]
+ );
- // Get version info first
+ // Get version info first.
$versionInfo = $this->getVersionInfo();
$this->logger->info('SettingsService: Pre-import version info', $versionInfo);
- // Check if import is needed (unless forced)
- if (!$forceImport && $versionInfo['versionsMatch'] && $versionInfo['isFullyConfigured']) {
+ // Check if import is needed (unless forced).
+ if ($forceImport === null && $versionInfo['versionsMatch'] === true && $versionInfo['isFullyConfigured'] === true) {
$this->logger->info('SettingsService: Import not needed - versions match and fully configured');
return [
- 'success' => false,
- 'message' => 'Configuration is already up to date. Use force import if you want to reimport.',
- 'versionInfo' => $versionInfo
+ 'success' => false,
+ 'message' => 'Configuration is already up to date. Use force import if you want to reimport.',
+ 'versionInfo' => $versionInfo,
];
}
- // If force import is requested or auto-config not completed, reset auto-configuration flag
- if ($forceImport || !$versionInfo['autoConfigCompleted']) {
+ // If force import is requested or auto-config not completed, reset auto-configuration flag.
+ if ($forceImport === true || $versionInfo['autoConfigCompleted'] === false) {
$this->config->setValueString($this->_appName, 'auto_config_completed', 'false');
- $this->logger->info('SettingsService: Reset auto-configuration flag', [
- 'reason' => $forceImport ? 'force_import' : 'auto_config_not_completed'
- ]);
+ if ($forceImport === true) {
+ $reasonValue = 'force_import';
+ } else {
+ $reasonValue = 'auto_config_not_completed';
+ }
+
+ $this->logger->info(
+ 'SettingsService: Reset auto-configuration flag',
+ [
+ 'reason' => $reasonValue,
+ ]
+ );
}
- // Perform the import
+ // Perform the import.
$this->logger->info('SettingsService: Starting settings import');
- $importResult = $this->loadSettings($forceImport);
- $this->logger->info('SettingsService: Settings import completed', [
- 'import_result' => $importResult
- ]);
+ $importResult = $this->loadSettings(force: $forceImport);
+ $this->logger->info(
+ 'SettingsService: Settings import completed',
+ [
+ 'import_result' => $importResult,
+ ]
+ );
- // Auto-configure after successful import
+ // Auto-configure after successful import.
$autoConfigResult = null;
try {
$this->logger->info('SettingsService: Starting auto-configuration after import');
$autoConfigResult = $this->autoConfigureAfterImport();
- if (!empty($autoConfigResult)) {
+ if (empty($autoConfigResult) === false) {
$this->logger->info('SettingsService: Updating settings with auto-configuration result');
- $this->updateSettings($autoConfigResult);
- $this->logger->info('SettingsService: Auto-configuration completed after import', [
- 'configuration' => array_keys($autoConfigResult)
- ]);
+ $this->updateSettings(data: $autoConfigResult);
+ $this->logger->info(
+ 'SettingsService: Auto-configuration completed after import',
+ [
+ 'configuration' => array_keys($autoConfigResult),
+ ]
+ );
} else {
$this->logger->info('SettingsService: Auto-configuration yielded no results');
}
} catch (\Exception $e) {
- $this->logger->warning('SettingsService: Auto-configuration failed after import', [
- 'exception_message' => $e->getMessage(),
- 'exception' => $e
- ]);
- // Don't fail the entire import if auto-configuration fails
- }
-
- // Wait a moment for any async operations to complete
- usleep(100000); // 0.1 seconds
+ $this->logger->warning(
+ 'SettingsService: Auto-configuration failed after import',
+ [
+ 'exception_message' => $e->getMessage(),
+ 'exception' => $e,
+ ]
+ );
+ // Don't fail the entire import if auto-configuration fails.
+ }//end try
- // Get updated version info - this should now reflect the changes
+ // Wait a moment for any async operations to complete.
+ usleep(100000);
+ // 0.1 seconds.
+ // Get updated version info - this should now reflect the changes.
$this->logger->info('SettingsService: Getting updated version info after import');
$updatedVersionInfo = $this->getVersionInfo();
$this->logger->info('SettingsService: Post-import version info', $updatedVersionInfo);
$message = 'Configuration imported successfully';
- if (!empty($autoConfigResult)) {
+ if (empty($autoConfigResult) === false) {
$message .= ' and auto-configured';
}
- if ($forceImport) {
+
+ if (empty($forceImport) === false) {
$message .= ' (forced import)';
}
return [
- 'success' => true,
- 'message' => $message,
- 'importResult' => $importResult,
- 'autoConfigResult' => $autoConfigResult,
- 'versionInfo' => $updatedVersionInfo,
- 'configurationStatus' => $this->getConfigurationStatus()
+ 'success' => true,
+ 'message' => $message,
+ 'importResult' => $importResult,
+ 'autoConfigResult' => $autoConfigResult,
+ 'versionInfo' => $updatedVersionInfo,
+ 'configurationStatus' => $this->getConfigurationStatus(),
];
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Manual import failed', [
- 'exception_message' => $e->getMessage(),
- 'exception' => $e
- ]);
+ $this->logger->error(
+ 'SettingsService: Manual import failed',
+ [
+ 'exception_message' => $e->getMessage(),
+ 'exception' => $e,
+ ]
+ );
return [
- 'success' => false,
- 'message' => 'Import failed: ' . $e->getMessage(),
- 'error' => $e->getMessage(),
- 'versionInfo' => $this->getVersionInfo()
+ 'success' => false,
+ 'message' => 'Import failed: '.$e->getMessage(),
+ 'error' => $e->getMessage(),
+ 'versionInfo' => $this->getVersionInfo(),
];
- }
- }
+ }//end try
+ }//end manualImport()
/**
* Perform consolidated auto-configuration with clean separation of concerns
@@ -2810,86 +3160,94 @@ public function manualImport(bool $forceImport = false): array
* 3. AMEF register configuration
* 4. User groups configuration
*
- * @param bool $force Whether to force configuration loading
+ * @param bool $force Whether to force configuration loading.
+ *
* @return array Consolidated configuration results
*/
- public function performConsolidatedAutoConfiguration(bool $force = false): array
+ public function performConsolidatedAutoConfiguration(bool $force=false): array
{
- $this->logger->info('SettingsService: Starting consolidated auto-configuration', [
- 'force' => $force
- ]);
+ $this->logger->info(
+ 'SettingsService: Starting consolidated auto-configuration',
+ [
+ 'force' => $force,
+ ]
+ );
$results = [
- 'success' => true,
- 'message' => 'Auto-configuration completed successfully',
- 'steps' => [],
- 'errors' => [],
+ 'success' => true,
+ 'message' => 'Auto-configuration completed successfully',
+ 'steps' => [],
+ 'errors' => [],
'timestamp' => time(),
- 'force' => $force
+ 'force' => $force,
];
- // Step 1: Load configuration files
+ // Step 1: Load configuration files.
$this->logger->info('SettingsService: Step 1 - Loading configuration');
- $configResult = $this->loadConfiguration($force);
+ $configResult = $this->loadConfiguration(force: $force);
$results['steps']['configurationLoad'] = $configResult;
- $this->addStepResult($results, $configResult, 'Configuration loading');
+ $this->addStepResult(results: $results, stepResult: $configResult, stepName: 'Configuration loading');
- // Step 2: Configure Voorzieningen (Dutch register system)
+ // Step 2: Configure Voorzieningen (Dutch register system).
$this->logger->info('SettingsService: Step 2 - Configuring Voorzieningen');
$voorzieningenResult = $this->configureVoorzieningen();
$results['steps']['voorzieningenConfiguration'] = $voorzieningenResult;
- $this->addStepResult($results, $voorzieningenResult, 'Voorzieningen configuration');
+ $this->addStepResult(results: $results, stepResult: $voorzieningenResult, stepName: 'Voorzieningen configuration');
- // Step 3: Configure AMEF (ArchiMate/English register system)
+ // Step 3: Configure AMEF (ArchiMate/English register system).
$this->logger->info('SettingsService: Step 3 - Configuring AMEF');
$amefResult = $this->configureAmef();
$results['steps']['amefConfiguration'] = $amefResult;
- $this->addStepResult($results, $amefResult, 'AMEF configuration');
+ $this->addStepResult(results: $results, stepResult: $amefResult, stepName: 'AMEF configuration');
- // Step 4: Configure User Groups
+ // Step 4: Configure User Groups.
$this->logger->info('SettingsService: Step 4 - Configuring User Groups');
$groupsResult = $this->configureGroups();
$results['steps']['groupsConfiguration'] = $groupsResult;
- $this->addStepResult($results, $groupsResult, 'User groups configuration');
+ $this->addStepResult(results: $results, stepResult: $groupsResult, stepName: 'User groups configuration');
- // Determine overall success
- $results['success'] = empty($results['errors']);
- if (!$results['success']) {
+ // Determine overall success.
+ $results['success'] = empty($results['errors']) === true;
+ if ($results['success'] === false) {
$results['message'] = 'Auto-configuration completed with some issues';
}
- $this->logger->info('SettingsService: Consolidated auto-configuration completed', [
- 'success' => $results['success'],
- 'errors_count' => count($results['errors'])
- ]);
+ $this->logger->info(
+ 'SettingsService: Consolidated auto-configuration completed',
+ [
+ 'success' => $results['success'],
+ 'errors_count' => count($results['errors']),
+ ]
+ );
return $results;
- }
+ }//end performConsolidatedAutoConfiguration()
/**
* Load configuration files
*
- * @param bool $force Whether to force reload regardless of version
+ * @param bool $force Whether to force reload regardless of version.
+ *
* @return array Configuration loading result
*/
private function loadConfiguration(bool $force): array
{
try {
- $importResult = $this->manualImport($force);
+ $importResult = $this->manualImport(forceImport: $force);
return [
'success' => $importResult['success'],
'message' => $importResult['message'] ?? 'Configuration loaded',
- 'details' => $importResult
+ 'details' => $importResult,
];
} catch (\Exception $e) {
return [
'success' => false,
- 'message' => 'Configuration loading failed: ' . $e->getMessage(),
- 'error' => $e->getMessage()
+ 'message' => 'Configuration loading failed: '.$e->getMessage(),
+ 'error' => $e->getMessage(),
];
}
- }
+ }//end loadConfiguration()
/**
* Configure Voorzieningen register and schemas
@@ -2909,27 +3267,30 @@ private function configureVoorzieningen(): array
try {
$registerService = $this->getRegisterService();
- $registers = $registerService->findAll();
+ $registers = $registerService->findAll();
} catch (\TypeError | \Exception $e) {
- $this->logger->warning('OpenRegister RegisterService->findAll() failed in configureVoorzieningen', [
- 'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine()
- ]);
+ $this->logger->warning(
+ 'OpenRegister RegisterService->findAll() failed in configureVoorzieningen',
+ [
+ 'exception' => $e->getMessage(),
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to retrieve registers: ' . $e->getMessage(),
+ 'message' => 'Failed to retrieve registers: '.$e->getMessage(),
];
}
- if (empty($registers)) {
+ if (empty($registers) === true) {
return [
'success' => false,
'message' => 'No registers available',
];
}
- // Get schema mapper to fetch schema details if needed
+ // Get schema mapper to fetch schema details if needed.
$schemaMapper = null;
try {
$schemaMapper = $this->container->get(\OCA\OpenRegister\Db\SchemaMapper::class);
@@ -2937,31 +3298,44 @@ private function configureVoorzieningen(): array
$this->logger->warning('SchemaMapper not available for Voorzieningen detection', ['error' => $e->getMessage()]);
}
- // Find the voorzieningen register by slug OR by presence of expected schema slugs
+ // Find the voorzieningen register by slug OR by presence of expected schema slugs.
$targetRegister = null;
- $expectedSlugs = [
- 'sector', 'suite', 'dienst', 'kwetsbaarheid', 'contactpersoon', 'organisatie',
- 'gebruik', 'contract', 'koppeling', 'beoordeeling', 'module', 'compliancy', 'moduleversie', 'moduleVersie'
+ $expectedSlugs = [
+ 'sector',
+ 'suite',
+ 'dienst',
+ 'kwetsbaarheid',
+ 'contactpersoon',
+ 'organisatie',
+ 'gebruik',
+ 'contract',
+ 'koppeling',
+ 'beoordeeling',
+ 'module',
+ 'compliancy',
+ 'moduleversie',
+ 'moduleVersie',
];
foreach ($registers as $register) {
- // Convert Register entity to array if needed
+ // Convert Register entity to array if needed.
if ($register instanceof \OCA\OpenRegister\Db\Register) {
$register = $register->jsonSerialize();
}
+
$slug = strtolower($register['slug'] ?? '');
if ($slug === 'voorzieningen') {
- // Fetch full schema details for the register
- $schemas = $register['schemas'] ?? [];
+ // Fetch full schema details for the register.
+ $schemas = $register['schemas'] ?? [];
$schemaDetails = [];
foreach ($schemas as $schema) {
- if (is_array($schema) && isset($schema['slug'])) {
- // Schema is already a full object
+ if (is_array($schema) === true && isset($schema['slug']) === true) {
+ // Schema is already a full object.
$schemaDetails[] = $schema;
- } elseif ((is_int($schema) || is_numeric($schema)) && $schemaMapper !== null) {
- // Schema is an ID - fetch details using SchemaMapper
+ } else if ((is_int($schema) === true || is_numeric($schema) === true) && $schemaMapper !== null) {
+ // Schema is an ID - fetch details using SchemaMapper.
try {
- $schemaEntity = $schemaMapper->find((int)$schema);
+ $schemaEntity = $schemaMapper->find((int) $schema);
if ($schemaEntity !== null) {
$schemaDetails[] = $schemaEntity->jsonSerialize();
}
@@ -2970,50 +3344,55 @@ private function configureVoorzieningen(): array
}
}
}
+
$register['schemas'] = $schemaDetails;
- $targetRegister = $register;
+ $targetRegister = $register;
break;
- }
- // Heuristic: count matching schemas
+ }//end if
+
+ // Heuristic: count matching schemas.
$schemaSlugs = [];
foreach (($register['schemas'] ?? []) as $schema) {
- if (is_array($schema) && isset($schema['slug'])) {
+ if (is_array($schema) === true && isset($schema['slug']) === true) {
$schemaSlugs[] = strtolower($schema['slug']);
- } elseif ((is_int($schema) || is_numeric($schema)) && $schemaMapper !== null) {
+ } else if ((is_int($schema) === true || is_numeric($schema) === true) && $schemaMapper !== null) {
try {
- $schemaEntity = $schemaMapper->find((int)$schema);
+ $schemaEntity = $schemaMapper->find((int) $schema);
if ($schemaEntity !== null) {
- $schemaArray = $schemaEntity->jsonSerialize();
+ $schemaArray = $schemaEntity->jsonSerialize();
$schemaSlugs[] = strtolower($schemaArray['slug'] ?? '');
}
} catch (\Exception $e) {
- // Skip schemas that can't be fetched
+ // Skip schemas that can't be fetched.
}
}
}
+
$matches = array_intersect($expectedSlugs, $schemaSlugs);
- if (count($matches) >= 6) { // good confidence
- // Fetch full schema details
- $schemas = $register['schemas'] ?? [];
+ if (count($matches) >= 6) {
+ // Good confidence.
+ // Fetch full schema details.
+ $schemas = $register['schemas'] ?? [];
$schemaDetails = [];
foreach ($schemas as $schema) {
- if (is_array($schema) && isset($schema['slug'])) {
+ if (is_array($schema) === true && isset($schema['slug']) === true) {
$schemaDetails[] = $schema;
- } elseif ((is_int($schema) || is_numeric($schema)) && $schemaMapper !== null) {
+ } else if ((is_int($schema) === true || is_numeric($schema) === true) && $schemaMapper !== null) {
try {
- $schemaEntity = $schemaMapper->find((int)$schema);
+ $schemaEntity = $schemaMapper->find((int) $schema);
if ($schemaEntity !== null) {
$schemaDetails[] = $schemaEntity->jsonSerialize();
}
} catch (\Exception $e) {
- // Skip
+ // Skip.
}
}
}
+
$register['schemas'] = $schemaDetails;
- $targetRegister = $register;
- }
- }
+ $targetRegister = $register;
+ }//end if
+ }//end foreach
if ($targetRegister === null) {
return [
@@ -3022,89 +3401,114 @@ private function configureVoorzieningen(): array
];
}
- // Map schema slugs to configuration keys based on actual register schemas
+ // Map schema slugs to configuration keys based on actual register schemas.
$slugToKey = [
- 'organisatie' => 'organisatie_schema',
+ 'organisatie' => 'organisatie_schema',
'contactpersoon' => 'contactpersoon_schema',
- 'suite' => 'suite_schema',
- 'dienst' => 'dienst_schema',
- 'kwetsbaarheid' => 'kwetsbaarheid_schema',
- 'gebruik' => 'gebruik_schema',
- 'contract' => 'contract_schema',
- 'koppeling' => 'koppeling_schema',
- 'beoordeeling' => 'beoordeeling_schema',
- 'module' => 'module_schema',
- 'compliancy' => 'compliancy_schema',
- 'moduleversie' => 'moduleVersie_schema', // Handle both moduleversie and moduleVersie
- 'moduleVersie' => 'moduleVersie_schema',
- 'sector' => 'sector_schema',
+ 'suite' => 'suite_schema',
+ 'dienst' => 'dienst_schema',
+ 'kwetsbaarheid' => 'kwetsbaarheid_schema',
+ 'gebruik' => 'gebruik_schema',
+ 'contract' => 'contract_schema',
+ 'koppeling' => 'koppeling_schema',
+ 'beoordeeling' => 'beoordeeling_schema',
+ 'module' => 'module_schema',
+ 'compliancy' => 'compliancy_schema',
+ 'moduleversie' => 'moduleVersie_schema',
+ // Handle both moduleversie and moduleVersie.
+ 'moduleVersie' => 'moduleVersie_schema',
+ 'sector' => 'sector_schema',
];
- $config = [ 'register' => (string)($targetRegister['id'] ?? '') ];
+ $config = [ 'register' => (string) ($targetRegister['id'] ?? '') ];
- $this->logger->info('DEBUG: About to process schemas', [
- 'register_id' => $targetRegister['id'],
- 'schemas_count' => count($targetRegister['schemas'] ?? []),
- 'slugToKey_map' => $slugToKey
- ]);
+ $this->logger->info(
+ 'DEBUG: About to process schemas',
+ [
+ 'register_id' => $targetRegister['id'],
+ 'schemas_count' => count($targetRegister['schemas'] ?? []),
+ 'slugToKey_map' => $slugToKey,
+ ]
+ );
foreach (($targetRegister['schemas'] ?? []) as $schema) {
- $originalSlug = $schema['slug'] ?? '';
+ $originalSlug = $schema['slug'] ?? '';
$lowercaseSlug = strtolower($originalSlug);
- $this->logger->info('DEBUG: Processing schema', [
- 'original_slug' => $originalSlug,
- 'lowercase_slug' => $lowercaseSlug,
- 'schema_id' => $schema['id'] ?? 'NO_ID',
- 'has_mapping_original' => isset($slugToKey[$originalSlug]) ? 'YES' : 'NO',
- 'has_mapping_lowercase' => isset($slugToKey[$lowercaseSlug]) ? 'YES' : 'NO'
- ]);
+ if (isset($slugToKey[$originalSlug]) === true) {
+ $hasMappingOriginalValue = 'YES';
+ } else {
+ $hasMappingOriginalValue = 'NO';
+ }
+
+ if (isset($slugToKey[$lowercaseSlug]) === true) {
+ $hasMappingLowercaseValue = 'YES';
+ } else {
+ $hasMappingLowercaseValue = 'NO';
+ }
+
+ $this->logger->info(
+ 'DEBUG: Processing schema',
+ [
+ 'original_slug' => $originalSlug,
+ 'lowercase_slug' => $lowercaseSlug,
+ 'schema_id' => $schema['id'] ?? 'NO_ID',
+ 'has_mapping_original' => $hasMappingOriginalValue,
+ 'has_mapping_lowercase' => $hasMappingLowercaseValue,
+ ]
+ );
$mappingKey = null;
- $usedSlug = null;
+ $usedSlug = null;
- // Try original case first, then lowercase
- if (isset($slugToKey[$originalSlug])) {
+ // Try original case first, then lowercase.
+ if (isset($slugToKey[$originalSlug]) === true) {
$mappingKey = $slugToKey[$originalSlug];
- $usedSlug = $originalSlug;
- } elseif (isset($slugToKey[$lowercaseSlug])) {
+ $usedSlug = $originalSlug;
+ } else if (isset($slugToKey[$lowercaseSlug]) === true) {
$mappingKey = $slugToKey[$lowercaseSlug];
- $usedSlug = $lowercaseSlug;
+ $usedSlug = $lowercaseSlug;
}
if ($mappingKey !== null) {
- $config[$mappingKey] = (string)$schema['id'];
- $this->logger->info('DEBUG: Mapped schema successfully', [
- 'used_slug' => $usedSlug,
- 'config_key' => $mappingKey,
- 'schema_id' => $schema['id']
- ]);
+ $config[$mappingKey] = (string) $schema['id'];
+ $this->logger->info(
+ 'DEBUG: Mapped schema successfully',
+ [
+ 'used_slug' => $usedSlug,
+ 'config_key' => $mappingKey,
+ 'schema_id' => $schema['id'],
+ ]
+ );
} else {
- $this->logger->debug('DEBUG: No mapping found for schema slug', [
- 'original_slug' => $originalSlug,
- 'lowercase_slug' => $lowercaseSlug
- ]);
+ $this->logger->debug(
+ 'DEBUG: No mapping found for schema slug',
+ [
+ 'original_slug' => $originalSlug,
+ 'lowercase_slug' => $lowercaseSlug,
+ ]
+ );
}
- }
+ }//end foreach
$this->logger->info('DEBUG: Final config before persist', ['config' => $config]);
- // Persist normalized config
- $this->setVoorzieningenConfig($config);
+ // Persist normalized config.
+ $this->setVoorzieningenConfig(config: $config);
return [
- 'success' => true,
- 'message' => 'Voorzieningen configured successfully',
+ 'success' => true,
+ 'message' => 'Voorzieningen configured successfully',
'configured' => $config,
];
} catch (\Exception $e) {
return [
'success' => false,
- 'message' => 'Voorzieningen configuration failed: ' . $e->getMessage(),
- 'error' => $e->getMessage(),
+ 'message' => 'Voorzieningen configuration failed: '.$e->getMessage(),
+ 'error' => $e->getMessage(),
];
- }
- }
+ }//end try
+ }//end configureVoorzieningen()
/**
* Configure AMEF register and schemas
@@ -3114,7 +3518,7 @@ private function configureVoorzieningen(): array
private function configureAmef(): array
{
try {
- // Get available registers
+ // Get available registers.
$objectService = $this->getObjectService();
if ($objectService === null) {
return [
@@ -3125,53 +3529,61 @@ private function configureAmef(): array
try {
$registerService = $this->getRegisterService();
- $registers = $registerService->findAll();
+ $registers = $registerService->findAll();
} catch (\TypeError | \Exception $e) {
- $this->logger->warning('OpenRegister RegisterService->findAll() failed in configureAmef', [
- 'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine()
- ]);
+ $this->logger->warning(
+ 'OpenRegister RegisterService->findAll() failed in configureAmef',
+ [
+ 'exception' => $e->getMessage(),
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to retrieve registers: ' . $e->getMessage(),
+ 'message' => 'Failed to retrieve registers: '.$e->getMessage(),
];
}
- if (empty($registers)) {
+ if (empty($registers) === true) {
return [
'success' => false,
'message' => 'No registers available',
];
}
- // Detect AMEF register by presence of core AMEF schemas (not by slug)
- $candidate = null;
+ // Detect AMEF register by presence of core AMEF schemas (not by slug).
+ $candidate = null;
$amefCoreSlugs = ['model', 'element', 'relation', 'view', 'organization', 'property', 'property-definition'];
- // Convert all registers to arrays first
- $registers = array_map(function($register) {
- return ($register instanceof \OCA\OpenRegister\Db\Register)
- ? $register->jsonSerialize()
- : (array)$register;
- }, $registers);
+ // Convert all registers to arrays first.
+ $registers = array_map(
+ function ($register) {
+ if (($register instanceof \OCA\OpenRegister\Db\Register)) {
+ return $register->jsonSerialize();
+ } else {
+ return (array) $register;
+ }
+ },
+ $registers
+ );
- // Collect all schema IDs for batch fetch
+ // Collect all schema IDs for batch fetch.
$allSchemaIds = [];
foreach ($registers as $register) {
foreach (($register['schemas'] ?? []) as $schema) {
- if (is_int($schema) || is_numeric($schema)) {
- $allSchemaIds[] = (int)$schema;
+ if (is_int($schema) === true || is_numeric($schema) === true) {
+ $allSchemaIds[] = (int) $schema;
}
}
}
- // Batch fetch all schemas in one query
+ // Batch fetch all schemas in one query.
$schemaMap = [];
- if (!empty($allSchemaIds)) {
+ if (empty($allSchemaIds) === false) {
try {
$schemaMapper = $this->container->get(\OCA\OpenRegister\Db\SchemaMapper::class);
- $schemas = $schemaMapper->findMultipleOptimized(array_unique($allSchemaIds));
+ $schemas = $schemaMapper->findMultipleOptimized(array_unique($allSchemaIds));
foreach ($schemas as $schema) {
$schemaMap[$schema->getId()] = $schema->jsonSerialize();
}
@@ -3181,40 +3593,46 @@ private function configureAmef(): array
}
foreach ($registers as $register) {
- // Handle schemas - they might be IDs (integers) or full objects
- $schemas = $register['schemas'] ?? [];
- $schemaSlugs = [];
+ // Handle schemas - they might be IDs (integers) or full objects.
+ $schemas = $register['schemas'] ?? [];
+ $schemaSlugs = [];
$schemaDetails = [];
foreach ($schemas as $schema) {
- if (is_array($schema) && isset($schema['slug'])) {
- // Schema is already a full object
- $schemaSlugs[] = strtolower($schema['slug']);
+ if (is_array($schema) === true && isset($schema['slug']) === true) {
+ // Schema is already a full object.
+ $schemaSlugs[] = strtolower($schema['slug']);
$schemaDetails[] = $schema;
- } elseif (is_int($schema) || is_numeric($schema)) {
- // Schema is an ID - get from pre-fetched map
- if (isset($schemaMap[(int)$schema])) {
- $schemaArray = $schemaMap[(int)$schema];
- $schemaSlugs[] = strtolower($schemaArray['slug'] ?? '');
+ } else if (is_int($schema) === true || is_numeric($schema) === true) {
+ // Schema is an ID - get from pre-fetched map.
+ if (isset($schemaMap[(int) $schema]) === true) {
+ $schemaArray = $schemaMap[(int) $schema];
+ $schemaSlugs[] = strtolower($schemaArray['slug'] ?? '');
$schemaDetails[] = $schemaArray;
}
}
}
- // Store schema details back for later use
+ // Store schema details back for later use.
$register['schemas'] = $schemaDetails;
$matches = array_intersect($amefCoreSlugs, $schemaSlugs);
- if (count($matches) >= 3) { // threshold: at least model + 2 others
+ if (count($matches) >= 3) {
+ // Threshold: at least model + 2 others.
$candidate = $register;
- // prefer the register with most matches
- if (!isset($bestCount) || count($matches) > $bestCount) {
- $best = $register;
+ // Prefer the register with most matches.
+ if (isset($bestCount) === false || count($matches) > $bestCount) {
+ $best = $register;
$bestCount = count($matches);
}
}
+ }//end foreach
+
+ if (isset($best) === true) {
+ $targetRegister = $best;
+ } else {
+ $targetRegister = $candidate;
}
- $targetRegister = isset($best) ? $best : $candidate;
if ($targetRegister === null) {
return [
@@ -3224,43 +3642,48 @@ private function configureAmef(): array
}
$config = [
- 'register' => (string)($targetRegister['id'] ?? ''),
- // Initialize all known keys with empty strings to provide a stable shape
- 'organization_schema' => '',
- 'element_schema' => '',
- 'relation_schema' => '',
- 'view_schema' => '',
- 'model_schema' => '',
+ 'register' => (string) ($targetRegister['id'] ?? ''),
+ // Initialize all known keys with empty strings to provide a stable shape.
+ 'organization_schema' => '',
+ 'element_schema' => '',
+ 'relation_schema' => '',
+ 'view_schema' => '',
+ 'model_schema' => '',
'property_definition_schema' => '',
];
foreach (($targetRegister['schemas'] ?? []) as $schema) {
- $slug = strtolower($schema['slug'] ?? '');
+ $slug = strtolower($schema['slug'] ?? '');
$allowed = ['organization','element','relation','view','model','property-definition'];
- if (in_array($slug, $allowed, true)) {
- // Handle property-definition schema with underscore in config key
- $configKey = $slug === 'property-definition' ? 'property_definition_schema' : $slug . '_schema';
- $config[$configKey] = (string)$schema['id'];
+ if (in_array($slug, $allowed, true) === true) {
+ // Handle property-definition schema with underscore in config key.
+ if ($slug === 'property-definition') {
+ $configKey = 'property_definition_schema';
+ } else {
+ $configKey = $slug.'_schema';
+ }
+
+ $config[$configKey] = (string) $schema['id'];
}
}
- // Persist consolidated AMEF config JSON
- $this->setAmefConfig($config);
+ // Persist consolidated AMEF config JSON.
+ $this->setAmefConfig(config: $config);
return [
- 'success' => true,
- 'message' => 'AMEF configuration completed successfully',
+ 'success' => true,
+ 'message' => 'AMEF configuration completed successfully',
'configured' => $config,
- 'errors' => [],
+ 'errors' => [],
];
} catch (\Exception $e) {
return [
'success' => false,
- 'message' => 'AMEF configuration failed: ' . $e->getMessage(),
- 'error' => $e->getMessage(),
+ 'message' => 'AMEF configuration failed: '.$e->getMessage(),
+ 'error' => $e->getMessage(),
];
- }
- }
+ }//end try
+ }//end configureAmef()
/**
* Configure required user groups
@@ -3270,44 +3693,48 @@ private function configureAmef(): array
private function configureGroups(): array
{
try {
- // Call the method to create required user groups
+ // Call the method to create required user groups.
$result = $this->createAndConfigureUserGroups();
return [
- 'success' => $result['success'],
- 'message' => $result['message'],
- 'created' => $result['created'] ?? [],
+ 'success' => $result['success'],
+ 'message' => $result['message'],
+ 'created' => $result['created'] ?? [],
'existing' => $result['existing'] ?? [],
- 'total' => $result['total'] ?? 0
+ 'total' => $result['total'] ?? 0,
];
} catch (\Exception $e) {
return [
'success' => false,
- 'message' => 'User groups configuration failed: ' . $e->getMessage(),
- 'error' => $e->getMessage()
+ 'message' => 'User groups configuration failed: '.$e->getMessage(),
+ 'error' => $e->getMessage(),
];
}
- }
+ }//end configureGroups()
/**
* Add step result to overall results and handle errors
*
- * @param array &$results The results array (passed by reference)
- * @param array $stepResult The result of a configuration step
- * @param string $stepName The name of the step for error reporting
+ * @param array $results The results array (passed by reference).
+ * @param array $stepResult The result of a configuration step.
+ * @param string $stepName The name of the step for error reporting.
+ *
* @return void
*/
private function addStepResult(array &$results, array $stepResult, string $stepName): void
{
- if (!$stepResult['success']) {
- $results['errors'][] = $stepName . ' failed: ' . ($stepResult['message'] ?? 'Unknown error');
- $this->logger->warning("SettingsService: {$stepName} failed", [
- 'error' => $stepResult['message'] ?? 'Unknown error'
- ]);
+ if ($stepResult['success'] === false) {
+ $results['errors'][] = $stepName.' failed: '.($stepResult['message'] ?? 'Unknown error');
+ $this->logger->warning(
+ "SettingsService: {$stepName} failed",
+ [
+ 'error' => $stepResult['message'] ?? 'Unknown error',
+ ]
+ );
} else {
$this->logger->info("SettingsService: {$stepName} successful");
}
- }
+ }//end addStepResult()
/**
* Get consolidated configuration as JSON objects
@@ -3316,31 +3743,31 @@ private function addStepResult(array &$results, array $stepResult, string $stepN
*/
public function getConsolidatedConfiguration(): array
{
- // Get email config and include templates
+ // Get email config and include templates.
$emailConfig = $this->getEmailConfig();
$emailConfig['templates'] = [
- 'organization_registration' => $this->getEmailTemplate('organization_registration'),
- 'organization_activation' => $this->getEmailTemplate('organization_activation'),
- 'user_creation' => $this->getEmailTemplate('user_creation'),
- 'user_password' => $this->getEmailTemplate('user_password'),
+ 'organization_registration' => $this->getEmailTemplate(templateName: 'organization_registration'),
+ 'organization_activation' => $this->getEmailTemplate(templateName: 'organization_activation'),
+ 'user_creation' => $this->getEmailTemplate(templateName: 'user_creation'),
+ 'user_password' => $this->getEmailTemplate(templateName: 'user_password'),
];
- // Get Voorzieningen and AMEF configs (without object counts for performance)
+ // Get Voorzieningen and AMEF configs (without object counts for performance).
$voorzieningenConfig = $this->getVoorzieningenConfig();
- $amefConfig = $this->getAmefConfig();
+ $amefConfig = $this->getAmefConfig();
return [
'voorzieningen' => $voorzieningenConfig,
- 'amef' => $amefConfig,
- 'email' => $emailConfig,
- 'archimate' => $this->getArchiMateStatus(),
- 'userGroups' => [
- 'generic' => $this->getGenericUserGroups(),
+ 'amef' => $amefConfig,
+ 'email' => $emailConfig,
+ 'archimate' => $this->getArchiMateStatus(),
+ 'userGroups' => [
+ 'generic' => $this->getGenericUserGroups(),
'organizationAdmin' => $this->getOrganizationAdminGroups(),
- 'superUser' => $this->getSuperUserGroups()
- ]
+ 'superUser' => $this->getSuperUserGroups(),
+ ],
];
- }
+ }//end getConsolidatedConfiguration()
/**
* Get Voorzieningen configuration as JSON object
@@ -3349,39 +3776,40 @@ public function getConsolidatedConfiguration(): array
*/
public function getVoorzieningenConfig(): array
{
- $config = $this->config->getValueString($this->_appName, 'voorzieningen_config', '{}');
+ $config = $this->config->getValueString($this->_appName, 'voorzieningen_config', '{}');
$decoded = json_decode($config, true);
- // Backward compatibility: build minimal structure from legacy scalar keys
- if (!is_array($decoded)) {
+ // Backward compatibility: build minimal structure from legacy scalar keys.
+ if (is_array($decoded) === false) {
$decoded = [
- 'register' => $this->config->getValueString($this->_appName, 'voorzieningen_register', ''),
- 'organisatie_schema' => $this->config->getValueString($this->_appName, 'voorzieningen_organisatie_schema', ''),
+ 'register' => $this->config->getValueString($this->_appName, 'voorzieningen_register', ''),
+ 'organisatie_schema' => $this->config->getValueString($this->_appName, 'voorzieningen_organisatie_schema', ''),
'contactpersoon_schema' => $this->config->getValueString($this->_appName, 'voorzieningen_contactpersoon_schema', ''),
];
}
- // Normalize to the new, clean structure: no *_source or *_register keys,
- // include all known schema keys, and accept legacy 'voorzieningen_*_schema' fallbacks
- return $this->normalizeVoorzieningenConfig($decoded);
- }
+ // Normalize to the new, clean structure: no *_source or *_register keys,.
+ // include all known schema keys, and accept legacy 'voorzieningen_*_schema' fallbacks.
+ return $this->normalizeVoorzieningenConfig(input: $decoded);
+ }//end getVoorzieningenConfig()
/**
* Set Voorzieningen configuration as JSON object
*
- * @param array $config The voorzieningen configuration
+ * @param array $config The voorzieningen configuration.
+ *
* @return void
*/
public function setVoorzieningenConfig(array $config): void
{
- // Clear cache since voorzieningen config affects schema and register IDs
+ // Clear cache since voorzieningen config affects schema and register IDs.
$this->clearConfigurationCache();
- // Persist only normalized structure
- $normalized = $this->normalizeVoorzieningenConfig($config);
+ // Persist only normalized structure.
+ $normalized = $this->normalizeVoorzieningenConfig(input: $config);
$jsonConfig = json_encode($normalized, JSON_PRETTY_PRINT);
$this->config->setValueString($this->_appName, 'voorzieningen_config', $jsonConfig);
- }
+ }//end setVoorzieningenConfig()
/**
* Normalize voorzieningen configuration to the new, clean format.
@@ -3389,17 +3817,22 @@ public function setVoorzieningenConfig(array $config): void
* - Drop any '*_source' and '*_register' keys
* - Ensure all known schema keys are present (null if missing)
*
- * @param array $input Raw/legacy configuration
- * @return array Normalized configuration
+ * @param array $input Raw/legacy configuration.
+ *
+ * @return array Normalized configuration.
*/
private function normalizeVoorzieningenConfig(array $input): array
{
$normalized = [];
- // Register id
- $normalized['register'] = isset($input['register']) ? (string)$input['register'] : '';
+ // Register id.
+ if (isset($input['register']) === true) {
+ $normalized['register'] = (string) $input['register'];
+ } else {
+ $normalized['register'] = '';
+ }
- // Known schema keys to support - updated to match actual schemas from register
+ // Known schema keys to support - updated to match actual schemas from register.
$schemaKeys = [
'organisatie_schema',
'contactpersoon_schema',
@@ -3416,18 +3849,22 @@ private function normalizeVoorzieningenConfig(array $input): array
'sector_schema',
];
- // Copy any present schema keys; ignore sources/registers
+ // Copy any present schema keys; ignore sources/registers.
foreach ($schemaKeys as $key) {
- if (array_key_exists($key, $input)) {
- $normalized[$key] = $input[$key] === null ? '' : (string)$input[$key];
+ if (array_key_exists($key, $input) === true) {
+ if ($input[$key] === null) {
+ $normalized[$key] = '';
+ } else {
+ $normalized[$key] = (string) $input[$key];
+ }
} else {
- // Accept legacy keys that might be nested under 'voorzieningen_*_schema'
+ // Accept legacy keys that might be nested under 'voorzieningen_*_schema'.
$normalized[$key] = '';
}
}
return $normalized;
- }
+ }//end normalizeVoorzieningenConfig()
/**
* Gets AMEF configuration using ArchiMateService to avoid code duplication
@@ -3440,46 +3877,49 @@ private function normalizeVoorzieningenConfig(array $input): array
public function getAmefConfig(): array
{
try {
- // Get ArchiMateService from container to avoid circular dependency
+ // Get ArchiMateService from container to avoid circular dependency.
$archiMateService = $this->container->get(\OCA\SoftwareCatalog\Service\ArchiMateService::class);
- // Use reflection to access the private getAmefConfig method
+ // Use reflection to access the private getAmefConfig method.
$reflection = new \ReflectionClass($archiMateService);
- $method = $reflection->getMethod('getAmefConfig');
+ $method = $reflection->getMethod('getAmefConfig');
$method->setAccessible(true);
return $method->invoke($archiMateService);
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to get AMEF config from ArchiMateService', [
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to get AMEF config from ArchiMateService',
+ [
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
- // Fallback to direct config access if ArchiMateService is not available
- $config = $this->config->getValueString($this->_appName, 'amef_config', '{}');
+ // Fallback to direct config access if ArchiMateService is not available.
+ $config = $this->config->getValueString($this->_appName, 'amef_config', '{}');
$decoded = json_decode($config, true);
- if (!is_array($decoded)) {
- // Fallback to individual config values for backward compatibility
+ if (is_array($decoded) === false) {
+ // Fallback to individual config values for backward compatibility.
$decoded = [
- 'register_id' => $this->config->getValueString($this->_appName, 'amef_register_id', ''),
+ 'register_id' => $this->config->getValueString($this->_appName, 'amef_register_id', ''),
'organizations_schema' => $this->config->getValueString($this->_appName, 'amef_organizations_schema', ''),
- 'elements_schema' => $this->config->getValueString($this->_appName, 'amef_elements_schema', ''),
+ 'elements_schema' => $this->config->getValueString($this->_appName, 'amef_elements_schema', ''),
'relationships_schema' => $this->config->getValueString($this->_appName, 'amef_relationships_schema', ''),
- 'views_schema' => $this->config->getValueString($this->_appName, 'amef_views_schema', ''),
- 'models_schema' => $this->config->getValueString($this->_appName, 'amef_models_schema', '')
+ 'views_schema' => $this->config->getValueString($this->_appName, 'amef_views_schema', ''),
+ 'models_schema' => $this->config->getValueString($this->_appName, 'amef_models_schema', ''),
];
}
return $decoded;
- }
- }
+ }//end try
+ }//end getAmefConfig()
/**
* Set AMEF configuration as JSON object
*
- * @param array $config The AMEF configuration
+ * @param array $config The AMEF configuration.
+ *
* @return void
*/
public function setAmefConfig(array $config): void
@@ -3487,14 +3927,17 @@ public function setAmefConfig(array $config): void
$jsonConfig = json_encode($config, JSON_PRETTY_PRINT);
$this->config->setValueString($this->_appName, 'amef_config', $jsonConfig);
- // Clear configuration cache when AMEF config is updated
+ // Clear configuration cache when AMEF config is updated.
$this->clearConfigurationCache();
- $this->logger->debug('SettingsService: AMEF configuration updated and cache cleared', [
- 'config_keys' => array_keys($config),
- 'cache_cleared' => true
- ]);
- }
+ $this->logger->debug(
+ 'SettingsService: AMEF configuration updated and cache cleared',
+ [
+ 'config_keys' => array_keys($config),
+ 'cache_cleared' => true,
+ ]
+ );
+ }//end setAmefConfig()
/**
* Get Email configuration as JSON object
@@ -3503,43 +3946,44 @@ public function setAmefConfig(array $config): void
*/
public function getEmailConfig(): array
{
- $config = $this->config->getValueString($this->_appName, 'email_config', '{}');
+ $config = $this->config->getValueString($this->_appName, 'email_config', '{}');
$decoded = json_decode($config, true);
- if (!is_array($decoded)) {
- // Fallback to individual config values for backward compatibility
+ if (is_array($decoded) === false) {
+ // Fallback to individual config values for backward compatibility.
$decoded = [
- 'enabled' => $this->config->getValueString($this->_appName, 'email_enabled', 'false') === 'true',
- 'transport_type' => $this->config->getValueString($this->_appName, 'email_transport_type', 'smtp'),
- 'smtp_host' => $this->config->getValueString($this->_appName, 'email_smtp_host', ''),
- 'smtp_port' => $this->config->getValueString($this->_appName, 'email_smtp_port', '587'),
- 'smtp_username' => $this->config->getValueString($this->_appName, 'email_smtp_username', ''),
- 'smtp_password' => $this->config->getValueString($this->_appName, 'email_smtp_password', ''),
- 'smtp_encryption' => $this->config->getValueString($this->_appName, 'email_smtp_encryption', 'tls'),
- 'sender_email' => $this->config->getValueString($this->_appName, 'sender_email', ''),
- 'sender_name' => $this->config->getValueString($this->_appName, 'sender_name', ''),
- 'mailjet_api_key' => $this->config->getValueString($this->_appName, 'email_mailjet_api_key', ''),
- 'mailjet_secret_key' => $this->config->getValueString($this->_appName, 'email_mailjet_secret_key', '')
+ 'enabled' => $this->config->getValueString($this->_appName, 'email_enabled', 'false') === 'true',
+ 'transport_type' => $this->config->getValueString($this->_appName, 'email_transport_type', 'smtp'),
+ 'smtp_host' => $this->config->getValueString($this->_appName, 'email_smtp_host', ''),
+ 'smtp_port' => $this->config->getValueString($this->_appName, 'email_smtp_port', '587'),
+ 'smtp_username' => $this->config->getValueString($this->_appName, 'email_smtp_username', ''),
+ 'smtp_password' => $this->config->getValueString($this->_appName, 'email_smtp_password', ''),
+ 'smtp_encryption' => $this->config->getValueString($this->_appName, 'email_smtp_encryption', 'tls'),
+ 'sender_email' => $this->config->getValueString($this->_appName, 'sender_email', ''),
+ 'sender_name' => $this->config->getValueString($this->_appName, 'sender_name', ''),
+ 'mailjet_api_key' => $this->config->getValueString($this->_appName, 'email_mailjet_api_key', ''),
+ 'mailjet_secret_key' => $this->config->getValueString($this->_appName, 'email_mailjet_secret_key', ''),
];
}
return $decoded;
- }
+ }//end getEmailConfig()
/**
* Set Email configuration as JSON object
*
- * @param array $config The email configuration
+ * @param array $config The email configuration.
+ *
* @return void
*/
public function setEmailConfig(array $config): void
{
- // Email config doesn't typically affect schema/register IDs, but clear cache for consistency
+ // Email config doesn't typically affect schema/register IDs, but clear cache for consistency.
$this->clearConfigurationCache();
$jsonConfig = json_encode($config, JSON_PRETTY_PRINT);
$this->config->setValueString($this->_appName, 'email_config', $jsonConfig);
- }
+ }//end setEmailConfig()
/**
* Get ArchiMate import/export status and AMEF object counts
@@ -3552,38 +3996,52 @@ public function setEmailConfig(array $config): void
public function getArchiMateStatus(): array
{
try {
- // Get ArchiMateService from container to avoid circular dependency
+ // Get ArchiMateService from container to avoid circular dependency.
$archiMateService = $this->container->get(\OCA\SoftwareCatalog\Service\ArchiMateService::class);
return $archiMateService->getArchiMateStatus();
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to get ArchiMate status from ArchiMateService', [
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to get ArchiMate status from ArchiMateService',
+ [
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
- // Fallback to direct config access if ArchiMateService is not available
+ // Fallback to direct config access if ArchiMateService is not available.
$importStatus = $this->config->getValueString($this->_appName, 'archimate_import_status', '{}');
$exportStatus = $this->config->getValueString($this->_appName, 'archimate_export_status', '{}');
$importDecoded = json_decode($importStatus, true);
$exportDecoded = json_decode($exportStatus, true);
- // Get AMEF object counts
+ // Get AMEF object counts.
$amefObjectCounts = $this->getAmefObjectCounts();
+ if (is_array($importDecoded) === true) {
+ $importValue = $importDecoded;
+ } else {
+ $importValue = [];
+ }
+
+ if (is_array($exportDecoded) === true) {
+ $exportValue = $exportDecoded;
+ } else {
+ $exportValue = [];
+ }
+
return [
- 'import' => is_array($importDecoded) ? $importDecoded : [],
- 'export' => is_array($exportDecoded) ? $exportDecoded : [],
- 'totalElementObjects' => $amefObjectCounts['totalElementObjects'],
- 'totalOrganizationObjects' => $amefObjectCounts['totalOrganizationObjects'],
- 'totalViewObjects' => $amefObjectCounts['totalViewObjects'],
+ 'import' => $importValue,
+ 'export' => $exportValue,
+ 'totalElementObjects' => $amefObjectCounts['totalElementObjects'],
+ 'totalOrganizationObjects' => $amefObjectCounts['totalOrganizationObjects'],
+ 'totalViewObjects' => $amefObjectCounts['totalViewObjects'],
'totalRelationshipsObjects' => $amefObjectCounts['totalRelationshipsObjects'],
- 'totalModelObjects' => $amefObjectCounts['totalModelObjects']
+ 'totalModelObjects' => $amefObjectCounts['totalModelObjects'],
];
- }
- }
+ }//end try
+ }//end getArchiMateStatus()
/**
* Get Voorzieningen object counts for statistics
@@ -3596,72 +4054,72 @@ private function getVoorzieningenObjectCounts(): array
$objectService = $this->getObjectService();
if ($objectService === null) {
return [
- 'totalOrganisatieObjects' => 0,
- 'totalContactpersoonObjects' => 0,
- 'totalVoorzieningObjects' => 0,
+ 'totalOrganisatieObjects' => 0,
+ 'totalContactpersoonObjects' => 0,
+ 'totalVoorzieningObjects' => 0,
'totalVoorzieningAanbodObjects' => 0,
'totalVoorzieningVersieObjects' => 0,
- 'totalKwetsbaarheidObjects' => 0,
- 'totalContractObjects' => 0,
- 'totalStandaardObjects' => 0,
- 'totalReviewObjects' => 0,
- 'totalKoppelingObjects' => 0,
- 'totalBeoordeelingObjects' => 0,
+ 'totalKwetsbaarheidObjects' => 0,
+ 'totalContractObjects' => 0,
+ 'totalStandaardObjects' => 0,
+ 'totalReviewObjects' => 0,
+ 'totalKoppelingObjects' => 0,
+ 'totalBeoordeelingObjects' => 0,
'totalVoorzieningModuleObjects' => 0,
- 'totalVerklaringObjects' => 0,
- 'totalKoppelingGebruikObjects' => 0,
- 'totalCompliancyObjects' => 0,
- 'totalModuleGebruikObjects' => 0,
- 'totalModuleVersieObjects' => 0,
- 'totalSectorObjects' => 0,
- 'totalGebruikObjects' => 0
+ 'totalVerklaringObjects' => 0,
+ 'totalKoppelingGebruikObjects' => 0,
+ 'totalCompliancyObjects' => 0,
+ 'totalModuleGebruikObjects' => 0,
+ 'totalModuleVersieObjects' => 0,
+ 'totalSectorObjects' => 0,
+ 'totalGebruikObjects' => 0,
];
- }
+ }//end if
$voorzieningenConfig = $this->getVoorzieningenConfig();
- $registerId = $voorzieningenConfig['register'] ?? null;
+ $registerId = $voorzieningenConfig['register'] ?? null;
- // Define all schema mappings
+ // Define all schema mappings.
$schemaMappings = [
- 'organisatie_schema' => 'totalOrganisatieObjects',
- 'contactpersoon_schema' => 'totalContactpersoonObjects',
- 'voorziening_schema' => 'totalVoorzieningObjects',
+ 'organisatie_schema' => 'totalOrganisatieObjects',
+ 'contactpersoon_schema' => 'totalContactpersoonObjects',
+ 'voorziening_schema' => 'totalVoorzieningObjects',
'voorziening_aanbod_schema' => 'totalVoorzieningAanbodObjects',
'voorziening_versie_schema' => 'totalVoorzieningVersieObjects',
- 'kwetsbaarheid_schema' => 'totalKwetsbaarheidObjects',
- 'contract_schema' => 'totalContractObjects',
- 'standaard_schema' => 'totalStandaardObjects',
- 'review_schema' => 'totalReviewObjects',
- 'koppeling_schema' => 'totalKoppelingObjects',
- 'beoordeeling_schema' => 'totalBeoordeelingObjects',
- 'module_schema' => 'totalVoorzieningModuleObjects',
- 'verklaring_schema' => 'totalVerklaringObjects',
- 'koppeling_gebruik_schema' => 'totalKoppelingGebruikObjects',
- 'compliancy_schema' => 'totalCompliancyObjects',
- 'module_gebruik_schema' => 'totalModuleGebruikObjects',
- 'module_versie_schema' => 'totalModuleVersieObjects',
- 'sector_schema' => 'totalSectorObjects',
- 'gebruik_schema' => 'totalGebruikObjects'
+ 'kwetsbaarheid_schema' => 'totalKwetsbaarheidObjects',
+ 'contract_schema' => 'totalContractObjects',
+ 'standaard_schema' => 'totalStandaardObjects',
+ 'review_schema' => 'totalReviewObjects',
+ 'koppeling_schema' => 'totalKoppelingObjects',
+ 'beoordeeling_schema' => 'totalBeoordeelingObjects',
+ 'module_schema' => 'totalVoorzieningModuleObjects',
+ 'verklaring_schema' => 'totalVerklaringObjects',
+ 'koppeling_gebruik_schema' => 'totalKoppelingGebruikObjects',
+ 'compliancy_schema' => 'totalCompliancyObjects',
+ 'module_gebruik_schema' => 'totalModuleGebruikObjects',
+ 'module_versie_schema' => 'totalModuleVersieObjects',
+ 'sector_schema' => 'totalSectorObjects',
+ 'gebruik_schema' => 'totalGebruikObjects',
];
$counts = [];
- // Initialize all counts to 0
+ // Initialize all counts to 0.
foreach ($schemaMappings as $key => $countKey) {
$counts[$countKey] = 0;
}
- // Count objects for each configured schema
+ // Count objects for each configured schema.
foreach ($schemaMappings as $configKey => $countKey) {
$schemaId = $voorzieningenConfig[$configKey] ?? null;
- if ($registerId && $schemaId) {
+ if ($registerId !== false && $schemaId === true) {
try {
- $query = [
+ $query = [
'@self' => [
'register' => (int) $registerId,
- 'schema' => (int) $schemaId
- ]
+ 'schema' => (int) $schemaId,
+ ],
];
$objects = $objectService->searchObjects($query);
$counts[$countKey] = count($objects);
@@ -3674,36 +4132,38 @@ private function getVoorzieningenObjectCounts(): array
$this->logger->debug('SettingsService: Retrieved Voorzieningen object counts', $counts);
return $counts;
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to get Voorzieningen object counts', [
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to get Voorzieningen object counts',
+ [
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
return [
- 'totalOrganisatieObjects' => 0,
- 'totalContactpersoonObjects' => 0,
- 'totalVoorzieningObjects' => 0,
+ 'totalOrganisatieObjects' => 0,
+ 'totalContactpersoonObjects' => 0,
+ 'totalVoorzieningObjects' => 0,
'totalVoorzieningAanbodObjects' => 0,
'totalVoorzieningVersieObjects' => 0,
- 'totalKwetsbaarheidObjects' => 0,
- 'totalContractObjects' => 0,
- 'totalStandaardObjects' => 0,
- 'totalReviewObjects' => 0,
- 'totalKoppelingObjects' => 0,
- 'totalBeoordeelingObjects' => 0,
+ 'totalKwetsbaarheidObjects' => 0,
+ 'totalContractObjects' => 0,
+ 'totalStandaardObjects' => 0,
+ 'totalReviewObjects' => 0,
+ 'totalKoppelingObjects' => 0,
+ 'totalBeoordeelingObjects' => 0,
'totalVoorzieningModuleObjects' => 0,
- 'totalVerklaringObjects' => 0,
- 'totalKoppelingGebruikObjects' => 0,
- 'totalCompliancyObjects' => 0,
- 'totalModuleGebruikObjects' => 0,
- 'totalModuleVersieObjects' => 0,
- 'totalSectorObjects' => 0,
- 'totalGebruikObjects' => 0
+ 'totalVerklaringObjects' => 0,
+ 'totalKoppelingGebruikObjects' => 0,
+ 'totalCompliancyObjects' => 0,
+ 'totalModuleGebruikObjects' => 0,
+ 'totalModuleVersieObjects' => 0,
+ 'totalSectorObjects' => 0,
+ 'totalGebruikObjects' => 0,
];
- }
- }
+ }//end try
+ }//end getVoorzieningenObjectCounts()
/**
* Gets AMEF object counts for consolidated configuration
@@ -3716,48 +4176,53 @@ private function getVoorzieningenObjectCounts(): array
private function getAmefObjectCounts(): array
{
try {
- // Get ArchiMateService from container to avoid circular dependency
+ // Get ArchiMateService from container to avoid circular dependency.
$archiMateService = $this->container->get(\OCA\SoftwareCatalog\Service\ArchiMateService::class);
- // Get object counts using ArchiMateService methods
- $elementObjects = $archiMateService->getElementObjects();
+ // Get object counts using ArchiMateService methods.
+ $elementObjects = $archiMateService->getElementObjects();
$organizationObjects = $archiMateService->getOrganizationObjects();
- $viewObjects = $archiMateService->getViewObjects();
+ $viewObjects = $archiMateService->getViewObjects();
$relationshipObjects = $archiMateService->getRelationshipObjects();
- $modelObjects = $archiMateService->getModelObjects();
-
- $this->logger->debug('SettingsService: Retrieved AMEF object counts', [
- 'elementObjects' => count($elementObjects),
- 'organizationObjects' => count($organizationObjects),
- 'viewObjects' => count($viewObjects),
- 'relationshipObjects' => count($relationshipObjects),
- 'modelObjects' => count($modelObjects)
- ]);
+ $modelObjects = $archiMateService->getModelObjects();
+
+ $this->logger->debug(
+ 'SettingsService: Retrieved AMEF object counts',
+ [
+ 'elementObjects' => count($elementObjects),
+ 'organizationObjects' => count($organizationObjects),
+ 'viewObjects' => count($viewObjects),
+ 'relationshipObjects' => count($relationshipObjects),
+ 'modelObjects' => count($modelObjects),
+ ]
+ );
return [
- 'totalElementObjects' => count($elementObjects),
- 'totalOrganizationObjects' => count($organizationObjects),
- 'totalViewObjects' => count($viewObjects),
+ 'totalElementObjects' => count($elementObjects),
+ 'totalOrganizationObjects' => count($organizationObjects),
+ 'totalViewObjects' => count($viewObjects),
'totalRelationshipsObjects' => count($relationshipObjects),
- 'totalModelObjects' => count($modelObjects)
+ 'totalModelObjects' => count($modelObjects),
];
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to get AMEF object counts', [
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to get AMEF object counts',
+ [
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
- // Return zero counts on error to prevent API failures
+ // Return zero counts on error to prevent API failures.
return [
- 'totalElementObjects' => 0,
- 'totalOrganizationObjects' => 0,
- 'totalViewObjects' => 0,
+ 'totalElementObjects' => 0,
+ 'totalOrganizationObjects' => 0,
+ 'totalViewObjects' => 0,
'totalRelationshipsObjects' => 0,
- 'totalModelObjects' => 0
+ 'totalModelObjects' => 0,
];
- }
- }
+ }//end try
+ }//end getAmefObjectCounts()
/**
* Set ArchiMate import status
@@ -3765,28 +4230,31 @@ private function getAmefObjectCounts(): array
* This method delegates to ArchiMateService to avoid code duplication
* and ensure consistency in ArchiMate status management.
*
- * @param array $status The import status
+ * @param array $status The import status.
+ *
* @return void
*/
public function setArchiMateImportStatus(array $status): void
{
try {
- // Get ArchiMateService from container to avoid circular dependency
+ // Get ArchiMateService from container to avoid circular dependency.
$archiMateService = $this->container->get(\OCA\SoftwareCatalog\Service\ArchiMateService::class);
$archiMateService->setArchiMateImportStatus($status);
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to set ArchiMate import status via ArchiMateService', [
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to set ArchiMate import status via ArchiMateService',
+ [
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
- // Fallback to direct config access if ArchiMateService is not available
+ // Fallback to direct config access if ArchiMateService is not available.
$jsonStatus = json_encode($status, JSON_PRETTY_PRINT);
$this->config->setValueString($this->_appName, 'archimate_import_status', $jsonStatus);
}
- }
+ }//end setArchiMateImportStatus()
/**
* Set ArchiMate export status
@@ -3794,28 +4262,31 @@ public function setArchiMateImportStatus(array $status): void
* This method delegates to ArchiMateService to avoid code duplication
* and ensure consistency in ArchiMate status management.
*
- * @param array $status The export status
+ * @param array $status The export status.
+ *
* @return void
*/
public function setArchiMateExportStatus(array $status): void
{
try {
- // Get ArchiMateService from container to avoid circular dependency
+ // Get ArchiMateService from container to avoid circular dependency.
$archiMateService = $this->container->get(\OCA\SoftwareCatalog\Service\ArchiMateService::class);
$archiMateService->setArchiMateExportStatus($status);
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to set ArchiMate export status via ArchiMateService', [
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to set ArchiMate export status via ArchiMateService',
+ [
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
- // Fallback to direct config access if ArchiMateService is not available
+ // Fallback to direct config access if ArchiMateService is not available.
$jsonStatus = json_encode($status, JSON_PRETTY_PRINT);
$this->config->setValueString($this->_appName, 'archimate_export_status', $jsonStatus);
}
- }
+ }//end setArchiMateExportStatus()
/**
* Clear ArchiMate import status
@@ -3828,29 +4299,31 @@ public function setArchiMateExportStatus(array $status): void
public function clearArchiMateImportStatus(): array
{
try {
- // Get ArchiMateService from container to avoid circular dependency
+ // Get ArchiMateService from container to avoid circular dependency.
$archiMateService = $this->container->get(\OCA\SoftwareCatalog\Service\ArchiMateService::class);
return $archiMateService->clearArchiMateImportStatus();
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to clear ArchiMate import status via ArchiMateService', [
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to clear ArchiMate import status via ArchiMateService',
+ [
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
- // Fallback to direct config access if ArchiMateService is not available
+ // Fallback to direct config access if ArchiMateService is not available.
$this->config->deleteKey($this->_appName, 'archimate_import_status');
return [
- 'cleared' => true,
+ 'cleared' => true,
'process_killed' => false,
- 'process_id' => null,
- 'was_running' => false,
- 'messages' => ['Import status cleared via fallback method']
+ 'process_id' => null,
+ 'was_running' => false,
+ 'messages' => ['Import status cleared via fallback method'],
];
- }
- }
+ }//end try
+ }//end clearArchiMateImportStatus()
/**
* Force kill running ArchiMate import process and clear status
@@ -3858,35 +4331,38 @@ public function clearArchiMateImportStatus(): array
* This method delegates to ArchiMateService to handle process termination
* and status cleanup.
*
- * @return array Kill operation result
+ * @return array Kill operation result
* @deprecated Use cancelArchiMateImport() instead
*/
public function killArchiMateImport(): array
{
try {
- // Get ArchiMateService from container to avoid circular dependency
+ // Get ArchiMateService from container to avoid circular dependency.
$archiMateService = $this->container->get(\OCA\SoftwareCatalog\Service\ArchiMateService::class);
- return $archiMateService->clearArchiMateImportStatus(true); // killProcess = true
-
+ return $archiMateService->clearArchiMateImportStatus(true);
+ // KillProcess = true.
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to kill ArchiMate import process via ArchiMateService', [
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to kill ArchiMate import process via ArchiMateService',
+ [
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
- // Fallback to just clearing config if ArchiMateService is not available
+ // Fallback to just clearing config if ArchiMateService is not available.
$this->config->deleteKey($this->_appName, 'archimate_import_status');
return [
- 'cleared' => true,
+ 'cleared' => true,
'process_killed' => false,
- 'process_id' => null,
- 'was_running' => false,
- 'messages' => ['Import status cleared via fallback method - could not kill process']
+ 'process_id' => null,
+ 'was_running' => false,
+ 'messages' => ['Import status cleared via fallback method - could not kill process'],
];
- }
- }
+ }//end try
+ }//end killArchiMateImport()
/**
* Cancel a running ArchiMate import
@@ -3899,31 +4375,33 @@ public function killArchiMateImport(): array
public function cancelArchiMateImport(): array
{
try {
- // Get ArchiMateService from container to avoid circular dependency
+ // Get ArchiMateService from container to avoid circular dependency.
$archiMateService = $this->container->get(\OCA\SoftwareCatalog\Service\ArchiMateService::class);
return $archiMateService->cancelArchiMateImport();
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to cancel ArchiMate import via ArchiMateService', [
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to cancel ArchiMate import via ArchiMateService',
+ [
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
- // Fallback to just clearing config if ArchiMateService is not available
+ // Fallback to just clearing config if ArchiMateService is not available.
$this->config->deleteKey($this->_appName, 'archimate_import_status');
return [
- 'cancelled' => true,
- 'was_running' => false,
- 'process_id' => null,
- 'process_killed' => false,
- 'status_cleared' => true,
+ 'cancelled' => true,
+ 'was_running' => false,
+ 'process_id' => null,
+ 'process_killed' => false,
+ 'status_cleared' => true,
'cancellation_time' => date('Y-m-d H:i:s'),
- 'messages' => ['Import status cleared via fallback method - ArchiMateService not available']
+ 'messages' => ['Import status cleared via fallback method - ArchiMateService not available'],
];
- }
- }
+ }//end try
+ }//end cancelArchiMateImport()
/**
* Clear ArchiMate export status
@@ -3936,21 +4414,23 @@ public function cancelArchiMateImport(): array
public function clearArchiMateExportStatus(): void
{
try {
- // Get ArchiMateService from container to avoid circular dependency
+ // Get ArchiMateService from container to avoid circular dependency.
$archiMateService = $this->container->get(\OCA\SoftwareCatalog\Service\ArchiMateService::class);
$archiMateService->clearArchiMateExportStatus();
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to clear ArchiMate export status via ArchiMateService', [
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to clear ArchiMate export status via ArchiMateService',
+ [
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
- // Fallback to direct config access if ArchiMateService is not available
+ // Fallback to direct config access if ArchiMateService is not available.
$this->config->deleteKey($this->_appName, 'archimate_export_status');
}
- }
+ }//end clearArchiMateExportStatus()
/**
* Compact existing individual configuration values to JSON format
@@ -3961,91 +4441,96 @@ public function clearArchiMateExportStatus(): void
public function compactToJsonConfiguration(): array
{
$results = [
- 'success' => true,
+ 'success' => true,
'migrated' => [],
- 'errors' => []
+ 'errors' => [],
];
try {
- // 1. Migrate Voorzieningen configuration
+ // 1. Migrate Voorzieningen configuration.
$voorzieningenConfig = [
- 'register' => $this->config->getValueString($this->_appName, 'voorzieningen_register', ''),
- 'organisatie_schema' => $this->config->getValueString($this->_appName, 'voorzieningen_organisatie_schema', ''),
- 'contactpersoon_schema' => $this->config->getValueString($this->_appName, 'voorzieningen_contactpersoon_schema', ''),
- 'organisatie_source' => $this->config->getValueString($this->_appName, 'voorzieningen_organisatie_source', 'openregister'),
- 'contactpersoon_source' => $this->config->getValueString($this->_appName, 'voorzieningen_contactpersoon_source', 'openregister'),
- 'organisatie_register' => $this->config->getValueString($this->_appName, 'voorzieningen_organisatie_register', ''),
+ 'register' => $this->config->getValueString($this->_appName, 'voorzieningen_register', ''),
+ 'organisatie_schema' => $this->config->getValueString($this->_appName, 'voorzieningen_organisatie_schema', ''),
+ 'contactpersoon_schema' => $this->config->getValueString($this->_appName, 'voorzieningen_contactpersoon_schema', ''),
+ 'organisatie_source' => $this->config->getValueString($this->_appName, 'voorzieningen_organisatie_source', 'openregister'),
+ 'contactpersoon_source' => $this->config->getValueString($this->_appName, 'voorzieningen_contactpersoon_source', 'openregister'),
+ 'organisatie_register' => $this->config->getValueString($this->_appName, 'voorzieningen_organisatie_register', ''),
'contactpersoon_register' => $this->config->getValueString($this->_appName, 'voorzieningen_contactpersoon_register', ''),
];
- $this->setVoorzieningenConfig($voorzieningenConfig);
+ $this->setVoorzieningenConfig(config: $voorzieningenConfig);
$results['migrated']['voorzieningen'] = $voorzieningenConfig;
- // 2. Migrate AMEF configuration
+ // 2. Migrate AMEF configuration.
$amefConfig = [
- 'register_id' => $this->config->getValueString($this->_appName, 'amef_register_id', ''),
- 'organizations_schema' => $this->config->getValueString($this->_appName, 'amef_organizations_schema', ''),
- 'elements_schema' => $this->config->getValueString($this->_appName, 'amef_elements_schema', ''),
- 'relationships_schema' => $this->config->getValueString($this->_appName, 'amef_relationships_schema', ''),
- 'views_schema' => $this->config->getValueString($this->_appName, 'amef_views_schema', ''),
- 'models_schema' => $this->config->getValueString($this->_appName, 'amef_models_schema', ''),
- 'organization_source' => $this->config->getValueString($this->_appName, 'amef_organization_source', 'openregister'),
+ 'register_id' => $this->config->getValueString($this->_appName, 'amef_register_id', ''),
+ 'organizations_schema' => $this->config->getValueString($this->_appName, 'amef_organizations_schema', ''),
+ 'elements_schema' => $this->config->getValueString($this->_appName, 'amef_elements_schema', ''),
+ 'relationships_schema' => $this->config->getValueString($this->_appName, 'amef_relationships_schema', ''),
+ 'views_schema' => $this->config->getValueString($this->_appName, 'amef_views_schema', ''),
+ 'models_schema' => $this->config->getValueString($this->_appName, 'amef_models_schema', ''),
+ 'organization_source' => $this->config->getValueString($this->_appName, 'amef_organization_source', 'openregister'),
'organization_register' => $this->config->getValueString($this->_appName, 'amef_organization_register', ''),
- 'organization_schema' => $this->config->getValueString($this->_appName, 'amef_organization_schema', ''),
- // Note: These duplicated entries with typos are kept for backward compatibility but should be cleaned up
- 'elementss_schema' => $this->config->getValueString($this->_appName, 'amef_elementss_schema', ''),
+ 'organization_schema' => $this->config->getValueString($this->_appName, 'amef_organization_schema', ''),
+ // Note: These duplicated entries with typos are kept for backward compatibility but should be cleaned up.
+ 'elementss_schema' => $this->config->getValueString($this->_appName, 'amef_elementss_schema', ''),
'organizationss_schema' => $this->config->getValueString($this->_appName, 'amef_organizationss_schema', ''),
- 'relationshipss_schema' => $this->config->getValueString($this->_appName, 'amef_relationshipss_schema', '')
+ 'relationshipss_schema' => $this->config->getValueString($this->_appName, 'amef_relationshipss_schema', ''),
];
- $this->setAmefConfig($amefConfig);
+ $this->setAmefConfig(config: $amefConfig);
$results['migrated']['amef'] = $amefConfig;
- // 3. Migrate Email configuration
+ // 3. Migrate Email configuration.
$emailConfig = [
- 'enabled' => $this->config->getValueString($this->_appName, 'email_enabled', 'false') === 'true',
- 'transport_type' => $this->config->getValueString($this->_appName, 'email_transport_type', 'smtp'),
- 'smtp_host' => $this->config->getValueString($this->_appName, 'email_smtp_host', ''),
- 'smtp_port' => $this->config->getValueString($this->_appName, 'email_smtp_port', '587'),
- 'smtp_username' => $this->config->getValueString($this->_appName, 'email_smtp_username', ''),
- 'smtp_password' => $this->config->getValueString($this->_appName, 'email_smtp_password', ''),
- 'smtp_encryption' => $this->config->getValueString($this->_appName, 'email_smtp_encryption', 'tls'),
- 'sender_email' => $this->config->getValueString($this->_appName, 'sender_email', ''),
- 'sender_name' => $this->config->getValueString($this->_appName, 'sender_name', ''),
- 'mailjet_api_key' => $this->config->getValueString($this->_appName, 'email_mailjet_api_key', ''),
- 'mailjet_secret_key' => $this->config->getValueString($this->_appName, 'email_mailjet_secret_key', ''),
- 'sendgrid_api_key' => $this->config->getValueString($this->_appName, 'email_sendgrid_api_key', ''),
- 'mailgun_api_key' => $this->config->getValueString($this->_appName, 'email_mailgun_api_key', ''),
- 'mailgun_domain' => $this->config->getValueString($this->_appName, 'email_mailgun_domain', ''),
- 'postmark_api_key' => $this->config->getValueString($this->_appName, 'email_postmark_api_key', ''),
- 'ses_access_key' => $this->config->getValueString($this->_appName, 'email_ses_access_key', ''),
- 'ses_secret_key' => $this->config->getValueString($this->_appName, 'email_ses_secret_key', ''),
- 'ses_region' => $this->config->getValueString($this->_appName, 'email_ses_region', 'us-east-1'),
+ 'enabled' => $this->config->getValueString($this->_appName, 'email_enabled', 'false') === 'true',
+ 'transport_type' => $this->config->getValueString($this->_appName, 'email_transport_type', 'smtp'),
+ 'smtp_host' => $this->config->getValueString($this->_appName, 'email_smtp_host', ''),
+ 'smtp_port' => $this->config->getValueString($this->_appName, 'email_smtp_port', '587'),
+ 'smtp_username' => $this->config->getValueString($this->_appName, 'email_smtp_username', ''),
+ 'smtp_password' => $this->config->getValueString($this->_appName, 'email_smtp_password', ''),
+ 'smtp_encryption' => $this->config->getValueString($this->_appName, 'email_smtp_encryption', 'tls'),
+ 'sender_email' => $this->config->getValueString($this->_appName, 'sender_email', ''),
+ 'sender_name' => $this->config->getValueString($this->_appName, 'sender_name', ''),
+ 'mailjet_api_key' => $this->config->getValueString($this->_appName, 'email_mailjet_api_key', ''),
+ 'mailjet_secret_key' => $this->config->getValueString($this->_appName, 'email_mailjet_secret_key', ''),
+ 'sendgrid_api_key' => $this->config->getValueString($this->_appName, 'email_sendgrid_api_key', ''),
+ 'mailgun_api_key' => $this->config->getValueString($this->_appName, 'email_mailgun_api_key', ''),
+ 'mailgun_domain' => $this->config->getValueString($this->_appName, 'email_mailgun_domain', ''),
+ 'postmark_api_key' => $this->config->getValueString($this->_appName, 'email_postmark_api_key', ''),
+ 'ses_access_key' => $this->config->getValueString($this->_appName, 'email_ses_access_key', ''),
+ 'ses_secret_key' => $this->config->getValueString($this->_appName, 'email_ses_secret_key', ''),
+ 'ses_region' => $this->config->getValueString($this->_appName, 'email_ses_region', 'us-east-1'),
'org_registration_enabled' => $this->config->getValueString($this->_appName, 'email_org_registration_enabled', 'true') === 'true',
- 'org_activation_enabled' => $this->config->getValueString($this->_appName, 'email_org_activation_enabled', 'true') === 'true',
- 'user_creation_enabled' => $this->config->getValueString($this->_appName, 'email_user_creation_enabled', 'true') === 'true',
- 'user_password_enabled' => $this->config->getValueString($this->_appName, 'email_user_password_enabled', 'true') === 'true',
- 'test_receiver_override' => $this->config->getValueString($this->_appName, 'test_receiver_override', '')
+ 'org_activation_enabled' => $this->config->getValueString($this->_appName, 'email_org_activation_enabled', 'true') === 'true',
+ 'user_creation_enabled' => $this->config->getValueString($this->_appName, 'email_user_creation_enabled', 'true') === 'true',
+ 'user_password_enabled' => $this->config->getValueString($this->_appName, 'email_user_password_enabled', 'true') === 'true',
+ 'test_receiver_override' => $this->config->getValueString($this->_appName, 'test_receiver_override', ''),
];
- $this->setEmailConfig($emailConfig);
+ $this->setEmailConfig(config: $emailConfig);
$results['migrated']['email'] = $emailConfig;
- $this->logger->info('Configuration compaction to JSON format completed successfully', [
- 'compacted_sections' => array_keys($results['migrated'])
- ]);
-
+ $this->logger->info(
+ 'Configuration compaction to JSON format completed successfully',
+ [
+ 'compacted_sections' => array_keys($results['migrated']),
+ ]
+ );
} catch (\Exception $e) {
- $results['success'] = false;
- $results['errors'][] = 'Compaction failed: ' . $e->getMessage();
- $this->logger->error('Configuration compaction to JSON format failed', [
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
- }
+ $results['success'] = false;
+ $results['errors'][] = 'Compaction failed: '.$e->getMessage();
+ $this->logger->error(
+ 'Configuration compaction to JSON format failed',
+ [
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
+ }//end try
return $results;
- }
+ }//end compactToJsonConfiguration()
/**
* Clean up old individual configuration values after compaction
@@ -4058,28 +4543,33 @@ public function cleanupOldConfiguration(): array
$results = [
'success' => true,
'cleaned' => [],
- 'errors' => []
+ 'errors' => [],
];
try {
- // List of old configuration keys to remove
+ // List of old configuration keys to remove.
$oldKeys = [
- // Voorzieningen keys - old individual keys
+ // Voorzieningen keys - old individual keys.
'voorzieningen_register',
'voorzieningen_organisatie_schema',
'voorzieningen_contactpersoon_schema',
- 'voorzieningen_gebruiker_schema', // Deprecated - no longer used
- 'voorzieningen_contactgegevens_schema', // Deprecated - no longer used
+ 'voorzieningen_gebruiker_schema',
+ // Deprecated - no longer used.
+ 'voorzieningen_contactgegevens_schema',
+ // Deprecated - no longer used.
'voorzieningen_organisatie_source',
'voorzieningen_contactpersoon_source',
- 'voorzieningen_gebruiker_source', // Deprecated - no longer used
- 'voorzieningen_contactgegevens_source', // Deprecated - no longer used
+ 'voorzieningen_gebruiker_source',
+ // Deprecated - no longer used.
+ 'voorzieningen_contactgegevens_source',
+ // Deprecated - no longer used.
'voorzieningen_organisatie_register',
'voorzieningen_contactpersoon_register',
- 'voorzieningen_gebruiker_register', // Deprecated - no longer used
- 'voorzieningen_contactgegevens_register', // Deprecated - no longer used
-
- // Old Voorzieningen schema keys that no longer exist in register
+ 'voorzieningen_gebruiker_register',
+ // Deprecated - no longer used.
+ 'voorzieningen_contactgegevens_register',
+ // Deprecated - no longer used.
+ // Old Voorzieningen schema keys that no longer exist in register.
'voorzieningen_voorziening_schema',
'voorzieningen_voorziening_aanbod_schema',
'voorzieningen_voorziening_versie_schema',
@@ -4091,7 +4581,7 @@ public function cleanupOldConfiguration(): array
'voorzieningen_module_gebruik_schema',
'voorzieningen_module_versie_schema',
- // AMEF keys - old individual keys
+ // AMEF keys - old individual keys.
'amef_register_id',
'amef_organizations_schema',
'amef_elements_schema',
@@ -4106,11 +4596,11 @@ public function cleanupOldConfiguration(): array
'amef_organizationss_schema',
'amef_relationshipss_schema',
- // AMEF keys with hyphen format (old)
+ // AMEF keys with hyphen format (old).
'amef_property-definition_schema',
- 'amef_extendview_schema', // No longer in register
-
- // Email keys
+ 'amef_extendview_schema',
+ // No longer in register.
+ // Email keys.
'email_enabled',
'email_transport_type',
'email_smtp_host',
@@ -4133,7 +4623,7 @@ public function cleanupOldConfiguration(): array
'email_org_activation_enabled',
'email_user_creation_enabled',
'email_user_password_enabled',
- 'test_receiver_override'
+ 'test_receiver_override',
];
foreach ($oldKeys as $key) {
@@ -4141,29 +4631,34 @@ public function cleanupOldConfiguration(): array
$this->config->deleteKey($this->_appName, $key);
$results['cleaned'][] = $key;
} catch (\Exception $e) {
- $results['errors'][] = "Failed to delete key '{$key}': " . $e->getMessage();
+ $results['errors'][] = "Failed to delete key '{$key}': ".$e->getMessage();
}
}
- $this->logger->info('Old configuration cleanup completed', [
- 'cleaned_keys' => count($results['cleaned']),
- 'errors' => count($results['errors'])
- ]);
-
+ $this->logger->info(
+ 'Old configuration cleanup completed',
+ [
+ 'cleaned_keys' => count($results['cleaned']),
+ 'errors' => count($results['errors']),
+ ]
+ );
} catch (\Exception $e) {
- $results['success'] = false;
- $results['errors'][] = 'Cleanup failed: ' . $e->getMessage();
- $this->logger->error('Old configuration cleanup failed', [
- 'error' => $e->getMessage()
- ]);
- }
+ $results['success'] = false;
+ $results['errors'][] = 'Cleanup failed: '.$e->getMessage();
+ $this->logger->error(
+ 'Old configuration cleanup failed',
+ [
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
return $results;
- }
+ }//end cleanupOldConfiguration()
- // ========================================================================
- // CONTROLLER BUSINESS LOGIC METHODS
- // ========================================================================
+ // ======================================================.
+ // CONTROLLER BUSINESS LOGIC METHODS.
+ // ======================================================.
/**
* Get all settings including user groups and email settings
@@ -4174,49 +4669,51 @@ public function cleanupOldConfiguration(): array
public function getAllSettings(): array
{
try {
- // Provide only lightweight settings data. Section-specific data is
+ // Provide only lightweight settings data. Section-specific data is.
// available via focused endpoints for performance.
$base = $this->getSettings();
$versionInfo = $this->getVersionInfo();
- // Get voorzieningen config (lightweight - just reads from config storage)
+ // Get voorzieningen config (lightweight - just reads from config storage).
$voorzieningenConfig = $this->getVoorzieningenConfig();
- // Get amef config directly from config storage (avoid heavy ArchiMateService call)
+ // Get amef config directly from config storage (avoid heavy ArchiMateService call).
$amefConfigJson = $this->config->getValueString($this->_appName, 'amef_config', '{}');
- $amefConfig = json_decode($amefConfigJson, true);
- if (!is_array($amefConfig)) {
+ $amefConfig = json_decode($amefConfigJson, true);
+ if (is_array($amefConfig) === false) {
$amefConfig = [
- 'register' => $this->config->getValueString($this->_appName, 'amef_register_id', ''),
+ 'register' => $this->config->getValueString($this->_appName, 'amef_register_id', ''),
'organization_schema' => $this->config->getValueString($this->_appName, 'amef_organizations_schema', ''),
- 'element_schema' => $this->config->getValueString($this->_appName, 'amef_elements_schema', ''),
- 'relation_schema' => $this->config->getValueString($this->_appName, 'amef_relationships_schema', ''),
- 'view_schema' => $this->config->getValueString($this->_appName, 'amef_views_schema', ''),
- 'model_schema' => $this->config->getValueString($this->_appName, 'amef_models_schema', '')
+ 'element_schema' => $this->config->getValueString($this->_appName, 'amef_elements_schema', ''),
+ 'relation_schema' => $this->config->getValueString($this->_appName, 'amef_relationships_schema', ''),
+ 'view_schema' => $this->config->getValueString($this->_appName, 'amef_views_schema', ''),
+ 'model_schema' => $this->config->getValueString($this->_appName, 'amef_models_schema', ''),
];
}
$result = [
- 'availableRegisters' => $base['availableRegisters'] ?? [],
- 'versionInfo' => $versionInfo,
+ 'availableRegisters' => $base['availableRegisters'] ?? [],
+ 'versionInfo' => $versionInfo,
'voorzieningenConfig' => $voorzieningenConfig,
- 'amefConfig' => $amefConfig,
- 'timestamp' => time(),
+ 'amefConfig' => $amefConfig,
+ 'timestamp' => time(),
];
return $result;
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to get all settings', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to get all settings',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'error' => $e->getMessage(),
+ 'error' => $e->getMessage(),
];
- }
- }
+ }//end try
+ }//end getAllSettings()
/**
* Get object counts statistics for all configured registers
@@ -4228,86 +4725,89 @@ public function getObjectCountsStatistics(): array
try {
$statistics = [
'voorzieningen' => [],
- 'amef' => [],
- 'timestamp' => time()
+ 'amef' => [],
+ 'timestamp' => time(),
];
- // Get Voorzieningen statistics
+ // Get Voorzieningen statistics.
try {
$voorzieningenConfig = $this->getVoorzieningenConfig();
$voorzieningenCounts = $this->getVoorzieningenObjectCounts();
$statistics['voorzieningen'] = [
- 'config' => $voorzieningenConfig,
+ 'config' => $voorzieningenConfig,
'object_counts' => $voorzieningenCounts,
- 'configured' => !empty($voorzieningenConfig['register']) && !empty($voorzieningenConfig['organisatie_schema'])
+ 'configured' => empty($voorzieningenConfig['register']) === false
+ && empty($voorzieningenConfig['organisatie_schema']) === false,
];
} catch (\Exception $e) {
$this->logger->error('Failed to get Voorzieningen statistics', ['error' => $e->getMessage()]);
$statistics['voorzieningen'] = [
- 'config' => [],
+ 'config' => [],
'object_counts' => ['totalOrganisatieObjects' => 0, 'totalContactpersoonObjects' => 0],
- 'configured' => false,
- 'error' => $e->getMessage()
+ 'configured' => false,
+ 'error' => $e->getMessage(),
];
}
- // Get AMEF statistics
+ // Get AMEF statistics.
try {
$amefConfig = $this->getAmefConfig();
$amefCounts = $this->getAmefObjectCounts();
$statistics['amef'] = [
- 'config' => $amefConfig,
+ 'config' => $amefConfig,
'object_counts' => $amefCounts,
- 'configured' => !empty($amefConfig['register_id']) && !empty($amefConfig['elements_schema'])
+ 'configured' => empty($amefConfig['register_id']) === false && empty($amefConfig['elements_schema']) === false,
];
} catch (\Exception $e) {
$this->logger->error('Failed to get AMEF statistics', ['error' => $e->getMessage()]);
$statistics['amef'] = [
- 'config' => [],
+ 'config' => [],
'object_counts' => [
- 'totalElementObjects' => 0,
- 'totalOrganizationObjects' => 0,
- 'totalViewObjects' => 0,
+ 'totalElementObjects' => 0,
+ 'totalOrganizationObjects' => 0,
+ 'totalViewObjects' => 0,
'totalRelationshipsObjects' => 0,
- 'totalModelObjects' => 0
+ 'totalModelObjects' => 0,
],
- 'configured' => false,
- 'error' => $e->getMessage()
+ 'configured' => false,
+ 'error' => $e->getMessage(),
];
- }
+ }//end try
return $statistics;
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to get object counts statistics', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to get object counts statistics',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'voorzieningen' => [
- 'config' => [],
+ 'config' => [],
'object_counts' => ['totalOrganisatieObjects' => 0, 'totalContactpersoonObjects' => 0],
- 'configured' => false,
- 'error' => $e->getMessage()
+ 'configured' => false,
+ 'error' => $e->getMessage(),
],
- 'amef' => [
- 'config' => [],
+ 'amef' => [
+ 'config' => [],
'object_counts' => [
- 'totalElementObjects' => 0,
- 'totalOrganizationObjects' => 0,
- 'totalViewObjects' => 0,
+ 'totalElementObjects' => 0,
+ 'totalOrganizationObjects' => 0,
+ 'totalViewObjects' => 0,
'totalRelationshipsObjects' => 0,
- 'totalModelObjects' => 0
+ 'totalModelObjects' => 0,
],
- 'configured' => false,
- 'error' => $e->getMessage()
+ 'configured' => false,
+ 'error' => $e->getMessage(),
],
- 'timestamp' => time(),
- 'error' => $e->getMessage()
+ 'timestamp' => time(),
+ 'error' => $e->getMessage(),
];
- }
- }
+ }//end try
+ }//end getObjectCountsStatistics()
/**
* Get all email templates with error handling
@@ -4318,11 +4818,11 @@ public function getObjectCountsStatistics(): array
public function getAllEmailTemplates(): array
{
$templateTypes = ['organization_registration', 'organization_activation', 'user_creation', 'user_password', 'user_organisation'];
- $templates = [];
+ $templates = [];
foreach ($templateTypes as $templateName) {
try {
- $templates[$templateName] = $this->getEmailTemplate($templateName);
+ $templates[$templateName] = $this->getEmailTemplate(templateName: $templateName);
} catch (\Exception $e) {
$this->logger->warning("Failed to get template {$templateName}", ['error' => $e->getMessage()]);
$templates[$templateName] = null;
@@ -4330,125 +4830,134 @@ public function getAllEmailTemplates(): array
}
return $templates;
- }
+ }//end getAllEmailTemplates()
/**
* Update generic user groups with validation
*
- * @param array $groups Groups to set
- * @return array Update result with validation
+ * @param array $groups Groups to set.
+ *
+ * @return array Update result with validation.
*/
public function updateGenericUserGroups(array $groups): array
{
try {
- $validation = $this->validateGroups($groups);
+ $validation = $this->validateGroups(groups: $groups);
- if (!empty($validation['invalid'])) {
+ if (empty($validation['invalid']) === false) {
return [
- 'success' => false,
- 'message' => 'Invalid group names provided',
- 'validation' => $validation
+ 'success' => false,
+ 'message' => 'Invalid group names provided',
+ 'validation' => $validation,
];
}
- $this->setGenericUserGroups($validation['valid']);
+ $this->setGenericUserGroups(groups: $validation['valid']);
return [
'success' => true,
'message' => 'Generic user groups updated successfully',
- 'groups' => $validation['valid']
+ 'groups' => $validation['valid'],
];
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to update generic user groups', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to update generic user groups',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to update generic user groups: ' . $e->getMessage()
+ 'message' => 'Failed to update generic user groups: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end updateGenericUserGroups()
/**
* Update organization admin groups with validation
*
- * @param array $groups Groups to set
- * @return array Update result with validation
+ * @param array $groups Groups to set.
+ *
+ * @return array Update result with validation.
*/
public function updateOrganizationAdminGroups(array $groups): array
{
try {
- $validation = $this->validateGroups($groups);
+ $validation = $this->validateGroups(groups: $groups);
- if (!empty($validation['invalid'])) {
+ if (empty($validation['invalid']) === false) {
return [
- 'success' => false,
- 'message' => 'Invalid group names provided',
- 'validation' => $validation
+ 'success' => false,
+ 'message' => 'Invalid group names provided',
+ 'validation' => $validation,
];
}
- $this->setOrganizationAdminGroups($validation['valid']);
+ $this->setOrganizationAdminGroups(groups: $validation['valid']);
return [
'success' => true,
'message' => 'Organization admin groups updated successfully',
- 'groups' => $validation['valid']
+ 'groups' => $validation['valid'],
];
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to update organization admin groups', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to update organization admin groups',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to update organization admin groups: ' . $e->getMessage()
+ 'message' => 'Failed to update organization admin groups: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end updateOrganizationAdminGroups()
/**
* Update super user groups with validation
*
- * @param array $groups Groups to set
- * @return array Update result with validation
+ * @param array $groups Groups to set.
+ *
+ * @return array Update result with validation.
*/
public function updateSuperUserGroups(array $groups): array
{
try {
- $validation = $this->validateGroups($groups);
+ $validation = $this->validateGroups(groups: $groups);
- if (!empty($validation['invalid'])) {
+ if (empty($validation['invalid']) === false) {
return [
- 'success' => false,
- 'message' => 'Invalid group names provided',
- 'validation' => $validation
+ 'success' => false,
+ 'message' => 'Invalid group names provided',
+ 'validation' => $validation,
];
}
- $this->setSuperUserGroups($validation['valid']);
+ $this->setSuperUserGroups(groups: $validation['valid']);
return [
'success' => true,
'message' => 'Super user groups updated successfully',
- 'groups' => $validation['valid']
+ 'groups' => $validation['valid'],
];
-
} catch (\Exception $e) {
- $this->logger->error('SettingsService: Failed to update super user groups', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'SettingsService: Failed to update super user groups',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to update super user groups: ' . $e->getMessage()
+ 'message' => 'Failed to update super user groups: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end updateSuperUserGroups()
- // ========================================================================
- // FOCUSED ENDPOINT METHODS FOR PERFORMANCE OPTIMIZATION
- // ========================================================================
+ // ======================================================.
+ // FOCUSED ENDPOINT METHODS FOR PERFORMANCE OPTIMIZATION.
+ // ======================================================.
/**
* Get ArchiMate configuration only
@@ -4462,21 +4971,24 @@ public function getArchiMateConfig(): array
$status = $this->getArchiMateStatus();
return [
- 'success' => true,
- 'config' => $config,
- 'status' => $status,
- 'timestamp' => time()
+ 'success' => true,
+ 'config' => $config,
+ 'status' => $status,
+ 'timestamp' => time(),
];
} catch (\Exception $e) {
- $this->logger->error('Failed to get ArchiMate config', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'Failed to get ArchiMate config',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to get ArchiMate config: ' . $e->getMessage()
+ 'message' => 'Failed to get ArchiMate config: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end getArchiMateConfig()
/**
* Update ArchiMate configuration
@@ -4488,24 +5000,27 @@ public function getArchiMateConfig(): array
public function updateArchiMateConfig(array $config): array
{
try {
- $this->setAmefConfig($config);
+ $this->setAmefConfig(config: $config);
return [
'success' => true,
'message' => 'ArchiMate configuration updated successfully',
- 'config' => $this->getAmefConfig()
+ 'config' => $this->getAmefConfig(),
];
} catch (\Exception $e) {
- $this->logger->error('Failed to update ArchiMate config', [
- 'exception' => $e->getMessage(),
- 'config' => $config
- ]);
+ $this->logger->error(
+ 'Failed to update ArchiMate config',
+ [
+ 'exception' => $e->getMessage(),
+ 'config' => $config,
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to update ArchiMate config: ' . $e->getMessage()
+ 'message' => 'Failed to update ArchiMate config: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end updateArchiMateConfig()
/**
* Get email configuration only
@@ -4515,25 +5030,28 @@ public function updateArchiMateConfig(array $config): array
public function getEmailConfigFocused(): array
{
try {
- $emailSettings = $this->getEmailSettings();
+ $emailSettings = $this->getEmailSettings();
$emailTemplates = $this->getAllEmailTemplates();
return [
- 'success' => true,
- 'emailSettings' => $emailSettings,
+ 'success' => true,
+ 'emailSettings' => $emailSettings,
'emailTemplates' => $emailTemplates,
- 'timestamp' => time()
+ 'timestamp' => time(),
];
} catch (\Exception $e) {
- $this->logger->error('Failed to get email config', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'Failed to get email config',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to get email config: ' . $e->getMessage()
+ 'message' => 'Failed to get email config: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end getEmailConfigFocused()
/**
* Update email configuration
@@ -4545,9 +5063,9 @@ public function getEmailConfigFocused(): array
public function updateEmailConfig(array $config): array
{
try {
- if (isset($config)) {
- $result = $this->updateEmailSettings($config);
- if (!$result['success']) {
+ if (isset($config) === true) {
+ $result = $this->updateEmailSettings(emailSettings: $config);
+ if ($result['success'] === false) {
return $result;
}
}
@@ -4555,19 +5073,22 @@ public function updateEmailConfig(array $config): array
return [
'success' => true,
'message' => 'Email configuration updated successfully',
- 'config' => $this->getEmailConfig()
+ 'config' => $this->getEmailConfig(),
];
} catch (\Exception $e) {
- $this->logger->error('Failed to update email config', [
- 'exception' => $e->getMessage(),
- 'config' => $config
- ]);
+ $this->logger->error(
+ 'Failed to update email config',
+ [
+ 'exception' => $e->getMessage(),
+ 'config' => $config,
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to update email config: ' . $e->getMessage()
+ 'message' => 'Failed to update email config: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end updateEmailConfig()
/**
* Get AMEF configuration only
@@ -4580,20 +5101,23 @@ public function getAmefConfigFocused(): array
$config = $this->getAmefConfig();
return [
- 'success' => true,
- 'config' => $config,
- 'timestamp' => time()
+ 'success' => true,
+ 'config' => $config,
+ 'timestamp' => time(),
];
} catch (\Exception $e) {
- $this->logger->error('Failed to get AMEF config', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'Failed to get AMEF config',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to get AMEF config: ' . $e->getMessage()
+ 'message' => 'Failed to get AMEF config: '.$e->getMessage(),
];
}
- }
+ }//end getAmefConfigFocused()
/**
* Update AMEF configuration
@@ -4605,21 +5129,28 @@ public function getAmefConfigFocused(): array
public function updateAmefConfig(array $config): array
{
try {
- // Remove framework routing keys
+ // Remove framework routing keys.
unset($config['_route']);
- // Load existing config to allow merging
+ // Load existing config to allow merging.
$existing = $this->getAmefConfig();
- if (!is_array($existing)) {
+ if (is_array($existing) === false) {
$existing = [];
}
- // Determine target register id
- $targetRegisterId = isset($config['register']) ? (string)$config['register']
- : (isset($existing['register']) ? (string)$existing['register'] : '');
+ // Determine target register id.
+ if (isset($config['register']) === true) {
+ $targetRegisterId = (string) $config['register'];
+ } else {
+ if (isset($existing['register']) === true) {
+ $targetRegisterId = (string) $existing['register'];
+ } else {
+ $targetRegisterId = '';
+ }
+ }
- // If a register is provided, validate that provided schema ids belong to that register
- // Only accept singular keys; ignore unknown keys silently
+ // If a register is provided, validate that provided schema ids belong to that register.
+ // Only accept singular keys; ignore unknown keys silently.
$allowedKeys = [
'organization_schema',
'element_schema',
@@ -4636,78 +5167,89 @@ public function updateAmefConfig(array $config): array
// Build a set of schema ids for the chosen register.
try {
$registerService = $this->getRegisterService();
- $registers = $registerService->findAll();
- $schemaIdSet = [];
+ $registers = $registerService->findAll();
+ $schemaIdSet = [];
foreach ($registers as $register) {
$register = $register->jsonSerialize();
- if ((string)($register['id'] ?? '') === $targetRegisterId) {
+ if ((string) ($register['id'] ?? '') === $targetRegisterId) {
foreach (($register['schemas'] ?? []) as $schema) {
- $schemaIdSet[(string)$schema['id']] = true;
+ $schemaIdSet[(string) $schema['id']] = true;
}
+
break;
}
}
} catch (\TypeError | \Exception $e) {
- $this->logger->warning('OpenRegister RegisterService->findAll() failed in updateAmefConfig', [
- 'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine()
- ]);
- // Continue with empty schema set which will cause validation to fail gracefully
+ $this->logger->warning(
+ 'OpenRegister RegisterService->findAll() failed in updateAmefConfig',
+ [
+ 'exception' => $e->getMessage(),
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ ]
+ );
+ // Continue with empty schema set which will cause validation to fail gracefully.
$schemaIdSet = [];
- }
+ }//end try
- // Validate each provided schema id against the chosen register
+ // Validate each provided schema id against the chosen register.
foreach ($allowedKeys as $key) {
- if (array_key_exists($key, $config)) {
- $value = (string)$config[$key];
- if ($value !== '' && isset($schemaIdSet[$value])) {
+ if (array_key_exists($key, $config) === true) {
+ $value = (string) $config[$key];
+ if ($value !== '' && isset($schemaIdSet[$value]) === true) {
$validated[$key] = $value;
} else {
- // Skip invalid or cross-register ids
- $this->logger->warning('SettingsService: Ignored AMEF config key due to invalid schema/register combination', [
- 'key' => $key,
- 'value' => $value,
- 'register' => $targetRegisterId,
- ]);
+ // Skip invalid or cross-register ids.
+ $this->logger->warning(
+ 'SettingsService: Ignored AMEF config key due to invalid schema/register combination',
+ [
+ 'key' => $key,
+ 'value' => $value,
+ 'register' => $targetRegisterId,
+ ]
+ );
}
}
}
- }
- }
+ }//end if
+ }//end if
- // Merge: keep register and any validated schema keys; drop unknowns
+ // Merge: keep register and any validated schema keys; drop unknowns.
$merged = $existing;
if ($targetRegisterId !== '') {
$merged['register'] = $targetRegisterId;
}
+
foreach ($allowedKeys as $key) {
- if (array_key_exists($key, $validated)) {
+ if (array_key_exists($key, $validated) === true) {
$merged[$key] = $validated[$key];
- } elseif (!array_key_exists($key, $merged)) {
- // Ensure key presence with empty string for frontend mapping stability
+ } else if (array_key_exists($key, $merged) === false) {
+ // Ensure key presence with empty string for frontend mapping stability.
$merged[$key] = '';
}
}
- $this->setAmefConfig($merged);
+ $this->setAmefConfig(config: $merged);
return [
'success' => true,
'message' => 'AMEF configuration updated successfully',
- 'config' => $this->getAmefConfig()
+ 'config' => $this->getAmefConfig(),
];
} catch (\Exception $e) {
- $this->logger->error('Failed to update AMEF config', [
- 'exception' => $e->getMessage(),
- 'config' => $config
- ]);
+ $this->logger->error(
+ 'Failed to update AMEF config',
+ [
+ 'exception' => $e->getMessage(),
+ 'config' => $config,
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to update AMEF config: ' . $e->getMessage()
+ 'message' => 'Failed to update AMEF config: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end updateAmefConfig()
/**
* Get Voorzieningen configuration only
@@ -4720,20 +5262,23 @@ public function getVoorzieningenConfigFocused(): array
$config = $this->getVoorzieningenConfig();
return [
- 'success' => true,
- 'config' => $config,
- 'timestamp' => time()
+ 'success' => true,
+ 'config' => $config,
+ 'timestamp' => time(),
];
} catch (\Exception $e) {
- $this->logger->error('Failed to get Voorzieningen config', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'Failed to get Voorzieningen config',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to get Voorzieningen config: ' . $e->getMessage()
+ 'message' => 'Failed to get Voorzieningen config: '.$e->getMessage(),
];
}
- }
+ }//end getVoorzieningenConfigFocused()
/**
* Update Voorzieningen configuration
@@ -4745,24 +5290,27 @@ public function getVoorzieningenConfigFocused(): array
public function updateVoorzieningenConfig(array $config): array
{
try {
- $this->setVoorzieningenConfig($config);
+ $this->setVoorzieningenConfig(config: $config);
return [
'success' => true,
'message' => 'Voorzieningen configuration updated successfully',
- 'config' => $this->getVoorzieningenConfig()
+ 'config' => $this->getVoorzieningenConfig(),
];
} catch (\Exception $e) {
- $this->logger->error('Failed to update Voorzieningen config', [
- 'exception' => $e->getMessage(),
- 'config' => $config
- ]);
+ $this->logger->error(
+ 'Failed to update Voorzieningen config',
+ [
+ 'exception' => $e->getMessage(),
+ 'config' => $config,
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to update Voorzieningen config: ' . $e->getMessage()
+ 'message' => 'Failed to update Voorzieningen config: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end updateVoorzieningenConfig()
/**
* Get object counts only (lightweight)
@@ -4774,24 +5322,27 @@ public function getObjectsCounts(): array
try {
$counts = [
'voorzieningen' => $this->getVoorzieningenObjectCounts(),
- 'amef' => $this->getAmefObjectCounts(),
- 'timestamp' => time()
+ 'amef' => $this->getAmefObjectCounts(),
+ 'timestamp' => time(),
];
return [
'success' => true,
- 'counts' => $counts
+ 'counts' => $counts,
];
} catch (\Exception $e) {
- $this->logger->error('Failed to get object counts', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'Failed to get object counts',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to get object counts: ' . $e->getMessage()
+ 'message' => 'Failed to get object counts: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end getObjectsCounts()
/**
* Get object statistics (full statistics with configuration)
@@ -4804,19 +5355,22 @@ public function getObjectsStatistics(): array
$statistics = $this->getObjectCountsStatistics();
return [
- 'success' => true,
- 'statistics' => $statistics
+ 'success' => true,
+ 'statistics' => $statistics,
];
} catch (\Exception $e) {
- $this->logger->error('Failed to get object statistics', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'Failed to get object statistics',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to get object statistics: ' . $e->getMessage()
+ 'message' => 'Failed to get object statistics: '.$e->getMessage(),
];
}
- }
+ }//end getObjectsStatistics()
/**
* Get user groups configuration only
@@ -4827,27 +5381,30 @@ public function getUserGroupsConfig(): array
{
try {
$config = [
- 'generic' => $this->getGenericUserGroups(),
+ 'generic' => $this->getGenericUserGroups(),
'organizationAdmin' => $this->getOrganizationAdminGroups(),
- 'superUser' => $this->getSuperUserGroups(),
- 'allGroups' => $this->getAllGroups()
+ 'superUser' => $this->getSuperUserGroups(),
+ 'allGroups' => $this->getAllGroups(),
];
return [
- 'success' => true,
- 'config' => $config,
- 'timestamp' => time()
+ 'success' => true,
+ 'config' => $config,
+ 'timestamp' => time(),
];
} catch (\Exception $e) {
- $this->logger->error('Failed to get user groups config', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'Failed to get user groups config',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to get user groups config: ' . $e->getMessage()
+ 'message' => 'Failed to get user groups config: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end getUserGroupsConfig()
/**
* Update user groups configuration
@@ -4861,47 +5418,53 @@ public function updateUserGroupsConfig(array $config): array
try {
$results = [];
- if (isset($config['generic'])) {
- $results['generic'] = $this->updateGenericUserGroups($config['generic']);
+ if (isset($config['generic']) === true) {
+ $results['generic'] = $this->updateGenericUserGroups(groups: $config['generic']);
}
- if (isset($config['organizationAdmin'])) {
- $results['organizationAdmin'] = $this->updateOrganizationAdminGroups($config['organizationAdmin']);
+ if (isset($config['organizationAdmin']) === true) {
+ $results['organizationAdmin'] = $this->updateOrganizationAdminGroups(groups: $config['organizationAdmin']);
}
- if (isset($config['superUser'])) {
- $results['superUser'] = $this->updateSuperUserGroups($config['superUser']);
+ if (isset($config['superUser']) === true) {
+ $results['superUser'] = $this->updateSuperUserGroups(groups: $config['superUser']);
}
- // Check if any updates failed
- $failed = array_filter($results, function($result) {
- return !$result['success'];
- });
+ // Check if any updates failed.
+ $failed = array_filter(
+ $results,
+ function ($result) {
+ return $result['success'] === false;
+ }
+ );
- if (!empty($failed)) {
+ if (empty($failed) === false) {
return [
'success' => false,
'message' => 'Some user group updates failed',
- 'results' => $results
+ 'results' => $results,
];
}
return [
'success' => true,
'message' => 'User groups configuration updated successfully',
- 'config' => $this->getUserGroupsConfig()
+ 'config' => $this->getUserGroupsConfig(),
];
} catch (\Exception $e) {
- $this->logger->error('Failed to update user groups config', [
- 'exception' => $e->getMessage(),
- 'config' => $config
- ]);
+ $this->logger->error(
+ 'Failed to update user groups config',
+ [
+ 'exception' => $e->getMessage(),
+ 'config' => $config,
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to update user groups config: ' . $e->getMessage()
+ 'message' => 'Failed to update user groups config: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end updateUserGroupsConfig()
/**
* Get catalog location
@@ -4911,18 +5474,19 @@ public function updateUserGroupsConfig(array $config): array
public function getCatalogLocation(): string
{
return $this->config->getValueString($this->_appName, 'catalog_location', '');
- }
+ }//end getCatalogLocation()
/**
* Set catalog location
*
- * @param string $location The catalog location URL
+ * @param string $location The catalog location URL.
+ *
* @return void
*/
public function setCatalogLocation(string $location): void
{
$this->config->setValueString($this->_appName, 'catalog_location', $location);
- }
+ }//end setCatalogLocation()
/**
* High-performance sync of OpenRegister organisations to voorzieningen register
@@ -4931,147 +5495,186 @@ public function setCatalogLocation(string $location): void
* Uses OpenRegister's ultraFastBulkSave for maximum performance.
*
* @param array $options Configuration options:
- * - batch_size: Number of organisations per batch (default: 500)
- * - dry_run: Only check what would be created (default: false)
+ * - batch_size: Number of organisations per batch (default: 500)
+ * - dry_run: Only check what would be created (default: false)
*
* @return array Sync results with performance metrics
*/
- public function syncOrganisationsToVoorzieningenOptimized(array $options = []): array
+ public function syncOrganisationsToVoorzieningenOptimized(array $options=[]): array
{
$startTime = microtime(true);
$batchSize = $options['batch_size'] ?? 500;
- $isDryRun = $options['dry_run'] ?? false;
+ $isDryRun = $options['dry_run'] ?? false;
try {
- $this->logger->info('Starting optimized organisation sync', [
- 'batch_size' => $batchSize,
- 'dry_run' => $isDryRun
- ]);
+ $this->logger->info(
+ 'Starting optimized organisation sync',
+ [
+ 'batch_size' => $batchSize,
+ 'dry_run' => $isDryRun,
+ ]
+ );
- // 1. Validate prerequisites
+ // 1. Validate prerequisites.
$objectService = $this->getObjectService();
if ($objectService === null) {
return ['success' => false, 'message' => 'OpenRegister service not available'];
}
$voorzieningenConfig = $this->getVoorzieningenConfig();
- if (empty($voorzieningenConfig['register']) || empty($voorzieningenConfig['organisatie_schema'])) {
+ if (empty($voorzieningenConfig['register']) === true || empty($voorzieningenConfig['organisatie_schema']) === true) {
return ['success' => false, 'message' => 'Voorzieningen register or organisatie schema not configured'];
}
- $this->logger->debug('Prerequisites validated', [
- 'register_id' => $voorzieningenConfig['register'],
- 'organisatie_schema_id' => $voorzieningenConfig['organisatie_schema']
- ]);
+ $this->logger->debug(
+ 'Prerequisites validated',
+ [
+ 'register_id' => $voorzieningenConfig['register'],
+ 'organisatie_schema_id' => $voorzieningenConfig['organisatie_schema'],
+ ]
+ );
- // 2. BULK FETCH: Get all organisations in one query
+ // 2. BULK FETCH: Get all organisations in one query.
$organisationMapper = $this->container->get(\OCA\OpenRegister\Db\OrganisationMapper::class);
- $allOrganisations = $organisationMapper->findAllWithUserCount();
+ $allOrganisations = $organisationMapper->findAllWithUserCount();
- $this->logger->info('Retrieved organisations from OpenRegister', [
- 'total_organisations' => count($allOrganisations)
- ]);
+ $this->logger->info(
+ 'Retrieved organisations from OpenRegister',
+ [
+ 'total_organisations' => count($allOrganisations),
+ ]
+ );
- // 3. BULK FETCH: Get existing organisaties in one query
+ // 3. BULK FETCH: Get existing organisaties in one query.
$existingOrganisaties = $objectService->searchObjectsPaginated(
query: [
- '@self' => [
+ '@self' => [
'register' => $voorzieningenConfig['register'],
- 'schema' => $voorzieningenConfig['organisatie_schema']
+ 'schema' => $voorzieningenConfig['organisatie_schema'],
],
- '_limit' => 10000 // Get all existing
+ '_limit' => 10000,
+ // Get all existing.
],
_rbac: false,
_multitenancy: false
);
- $this->logger->info('Retrieved existing organisaties from voorzieningen register', [
- 'existing_count' => count($existingOrganisaties['results'] ?? [])
- ]);
+ $this->logger->info(
+ 'Retrieved existing organisaties from voorzieningen register',
+ [
+ 'existing_count' => count($existingOrganisaties['results'] ?? []),
+ ]
+ );
+
+ // 4. MEMORY-EFFICIENT: Build lookup set for existing UUIDs.
+ // Now we can compare by UUID since we force UUIDs to match OpenRegister organisation UUIDs.
+ $existingUuids = array_flip(
+ array_map(
+ function ($org) {
+ if ($org instanceof \OCA\OpenRegister\Db\ObjectEntity) {
+ return $org->getUuid() ?? '';
+ }
- // 4. MEMORY-EFFICIENT: Build lookup set for existing UUIDs
- // Now we can compare by UUID since we force UUIDs to match OpenRegister organisation UUIDs
- $existingUuids = array_flip(array_map(function($org) {
- return $org['@self']['id'] ?? '';
- }, $existingOrganisaties['results'] ?? []));
+ return $org['@self']['id'] ?? '';
+ },
+ $existingOrganisaties['results'] ?? []
+ )
+ );
- $this->logger->debug('Deduplication analysis', [
- 'existing_uuids_count' => count($existingUuids),
- 'existing_uuids_sample' => array_slice(array_keys($existingUuids), 0, 3),
- 'total_openregister_orgs' => count($allOrganisations)
- ]);
+ $this->logger->debug(
+ 'Deduplication analysis',
+ [
+ 'existing_uuids_count' => count($existingUuids),
+ 'existing_uuids_sample' => array_slice(array_keys($existingUuids), 0, 3),
+ 'total_openregister_orgs' => count($allOrganisations),
+ ]
+ );
- // 5. BATCH PREPARATION: Filter and prepare objects for bulk creation
+ // 5. BATCH PREPARATION: Filter and prepare objects for bulk creation.
$organisationsToCreate = [];
- $skippedCount = 0;
+ $skippedCount = 0;
foreach ($allOrganisations as $organisation) {
$orgUuid = $organisation->getUuid();
- // DEBUG: Log first few comparisons
+ // DEBUG: Log first few comparisons.
if (count($organisationsToCreate) < 3) {
- $this->logger->debug('UUID comparison debug', [
- 'openregister_uuid' => $orgUuid,
- 'exists_in_voorzieningen' => isset($existingUuids[$orgUuid]),
- 'organisation_name' => $organisation->getName()
- ]);
+ $this->logger->debug(
+ 'UUID comparison debug',
+ [
+ 'openregister_uuid' => $orgUuid,
+ 'exists_in_voorzieningen' => isset($existingUuids[$orgUuid]) === true,
+ 'organisation_name' => $organisation->getName(),
+ ]
+ );
}
- // Skip if already exists (compare by UUID now that we force UUIDs)
- if (isset($existingUuids[$orgUuid])) {
+ // Skip if already exists (compare by UUID now that we force UUIDs).
+ if (isset($existingUuids[$orgUuid]) === true) {
$skippedCount++;
continue;
}
- // Prepare organisatie data with forced UUID
+ // Prepare organisatie data with forced UUID.
+ if ($organisation->getActive() === true) {
+ $statusValue = 'Actief';
+ } else {
+ $statusValue = 'Inactief';
+ }
+
$organisationsToCreate[] = [
- 'id' => $orgUuid, // Force the UUID to match OpenRegister organisation UUID
- '@self' => [
- 'id' => $orgUuid, // Also set in @self section for consistency
- 'uuid' => $orgUuid
+ 'id' => $orgUuid,
+ // Force the UUID to match OpenRegister organisation UUID.
+ '@self' => [
+ 'id' => $orgUuid,
+ // Also set in @self section for consistency.
+ 'uuid' => $orgUuid,
],
- 'naam' => $organisation->getName(),
- 'beschrijving' => $organisation->getDescription() ?? '',
- 'type' => $this->determineOrganisationType($organisation),
- 'status' => $organisation->getActive() ? 'Actief' : 'Inactief',
- 'website' => '',
- 'e-mailadres' => null,
- 'telefoonnummer' => null,
- 'oin' => '',
- 'cbs' => '',
- 'deelnemers' => [],
+ 'naam' => $organisation->getName(),
+ 'beschrijving' => $organisation->getDescription() ?? '',
+ 'type' => $this->determineOrganisationType(organisation: $organisation),
+ 'status' => $statusValue,
+ 'website' => '',
+ 'e-mailadres' => null,
+ 'telefoonnummer' => null,
+ 'oin' => '',
+ 'cbs' => '',
+ 'deelnemers' => [],
'contactpersonen' => [],
];
- }
+ }//end foreach
$results = [
'total_organisations' => count($allOrganisations),
- 'existing_count' => count($existingUuids),
- 'to_create_count' => count($organisationsToCreate),
- 'created_count' => 0,
- 'failed_count' => 0,
- 'batches_processed' => 0,
- 'performance' => []
+ 'existing_count' => count($existingUuids),
+ 'to_create_count' => count($organisationsToCreate),
+ 'created_count' => 0,
+ 'failed_count' => 0,
+ 'batches_processed' => 0,
+ 'performance' => [],
];
- $this->logger->info('Organisation analysis completed', [
- 'total' => $results['total_organisations'],
- 'existing' => $results['existing_count'],
- 'to_create' => $results['to_create_count'],
- 'skipped_count' => $skippedCount,
- 'deduplication_working' => $skippedCount > 0
- ]);
+ $this->logger->info(
+ 'Organisation analysis completed',
+ [
+ 'total' => $results['total_organisations'],
+ 'existing' => $results['existing_count'],
+ 'to_create' => $results['to_create_count'],
+ 'skipped_count' => $skippedCount,
+ 'deduplication_working' => $skippedCount > 0,
+ ]
+ );
- if ($isDryRun) {
+ if (empty($isDryRun) === false) {
$results['message'] = "DRY RUN: Would create {$results['to_create_count']} organisations";
return ['success' => true, 'results' => $results];
}
- if (empty($organisationsToCreate)) {
+ if (empty($organisationsToCreate) === true) {
$results['message'] = 'All organisations already exist in voorzieningen register';
return ['success' => true, 'results' => $results];
}
- // 6. ULTRA-FAST BULK PROCESSING: Process in optimized batches
+ // 6. ULTRA-FAST BULK PROCESSING: Process in optimized batches.
$objectService->setRegister($voorzieningenConfig['register']);
$objectService->setSchema($voorzieningenConfig['organisatie_schema']);
@@ -5081,110 +5684,142 @@ public function syncOrganisationsToVoorzieningenOptimized(array $options = []):
$batchStartTime = microtime(true);
try {
- $this->logger->debug('Processing batch', [
- 'batch' => $batchIndex + 1,
- 'total_batches' => count($batches),
- 'objects_in_batch' => count($batch)
- ]);
+ $this->logger->debug(
+ 'Processing batch',
+ [
+ 'batch' => $batchIndex + 1,
+ 'total_batches' => count($batches),
+ 'objects_in_batch' => count($batch),
+ ]
+ );
- // BULK OPERATION: Create entire batch in single operation
+ // BULK OPERATION: Create entire batch in single operation.
$bulkResult = $objectService->saveObjects(
objects: $batch,
register: $voorzieningenConfig['register'],
schema: $voorzieningenConfig['organisatie_schema'],
_rbac: false,
_multitenancy: false,
- validation: false, // Skip validation for performance
- events: false // Skip events for performance
+ validation: false,
+ // Skip validation for performance.
+ events: false
+ // Skip events for performance.
);
- $batchTime = microtime(true) - $batchStartTime;
+ $batchTime = microtime(true) - $batchStartTime;
$objectsPerSecond = count($batch) / $batchTime;
$results['created_count'] += $bulkResult['statistics']['saved'] ?? 0;
- $results['failed_count'] += $bulkResult['statistics']['errors'] ?? 0;
+ $results['failed_count'] += $bulkResult['statistics']['errors'] ?? 0;
$results['batches_processed']++;
$results['performance'][] = [
- 'batch' => $batchIndex + 1,
- 'objects' => count($batch),
- 'time_seconds' => round($batchTime, 3),
- 'objects_per_second' => round($objectsPerSecond, 0)
+ 'batch' => $batchIndex + 1,
+ 'objects' => count($batch),
+ 'time_seconds' => round($batchTime, 3),
+ 'objects_per_second' => round($objectsPerSecond, 0),
];
- $this->logger->info("Bulk organisation sync batch completed", [
- 'batch' => $batchIndex + 1,
- 'total_batches' => count($batches),
- 'objects_in_batch' => count($batch),
- 'objects_per_second' => round($objectsPerSecond, 0)
- ]);
-
+ $this->logger->info(
+ "Bulk organisation sync batch completed",
+ [
+ 'batch' => $batchIndex + 1,
+ 'total_batches' => count($batches),
+ 'objects_in_batch' => count($batch),
+ 'objects_per_second' => round($objectsPerSecond, 0),
+ ]
+ );
} catch (\Exception $e) {
$results['failed_count'] += count($batch);
- $this->logger->error("Bulk organisation sync batch failed", [
- 'batch' => $batchIndex + 1,
- 'error' => $e->getMessage(),
- 'objects_in_batch' => count($batch)
- ]);
- }
- }
+ $this->logger->error(
+ "Bulk organisation sync batch failed",
+ [
+ 'batch' => $batchIndex + 1,
+ 'error' => $e->getMessage(),
+ 'objects_in_batch' => count($batch),
+ ]
+ );
+ }//end try
+ }//end foreach
$totalTime = microtime(true) - $startTime;
- $overallPerformance = $results['created_count'] > 0 ? $results['created_count'] / $totalTime : 0;
+ if ($results['created_count'] > 0) {
+ $overallPerformance = $results['created_count'] / $totalTime;
+ } else {
+ $overallPerformance = 0;
+ }
+
+ if ($overallPerformance > 10) {
+ $estimatedImprovementValue = round($overallPerformance / 10, 1).'x faster than individual operations';
+ } else {
+ $estimatedImprovementValue = 'baseline';
+ }
+
+ $createdCount = $results['created_count'];
+ $existingCount = $results['existing_count'];
+ $failedCount = $results['failed_count'];
+ $syncMessage = "Sync completed: {$createdCount} created, {$existingCount} existing, {$failedCount} failed";
return [
'success' => true,
- 'message' => "Sync completed: {$results['created_count']} created, {$results['existing_count']} existing, {$results['failed_count']} failed",
- 'results' => array_merge($results, [
- 'total_time_seconds' => round($totalTime, 3),
- 'overall_objects_per_second' => round($overallPerformance, 0),
- 'estimated_improvement' => $overallPerformance > 10 ? round($overallPerformance / 10, 1) . 'x faster than individual operations' : 'baseline'
- ])
+ 'message' => $syncMessage,
+ 'results' => array_merge(
+ $results,
+ [
+ 'total_time_seconds' => round($totalTime, 3),
+ 'overall_objects_per_second' => round($overallPerformance, 0),
+ 'estimated_improvement' => $estimatedImprovementValue,
+ ]
+ ),
];
-
} catch (\Exception $e) {
- $this->logger->error('Organisation sync failed', [
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->logger->error(
+ 'Organisation sync failed',
+ [
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Organisation sync failed: ' . $e->getMessage(),
- 'error' => $e->getMessage()
+ 'message' => 'Organisation sync failed: '.$e->getMessage(),
+ 'error' => $e->getMessage(),
];
- }
- }
+ }//end try
+ }//end syncOrganisationsToVoorzieningenOptimized()
/**
* Determine organisation type based on organisation properties
*
- * @param \OCA\OpenRegister\Db\Organisation $organisation The organisation entity
- * @return string The organisation type
+ * @param \OCA\OpenRegister\Db\Organisation $organisation The organisation entity.
+ *
+ * @return string The organisation type.
*/
private function determineOrganisationType(\OCA\OpenRegister\Db\Organisation $organisation): string
{
- $name = strtolower($organisation->getName());
+ $name = strtolower($organisation->getName() === true);
if (strpos($name, 'gemeente') !== false) {
return 'Gemeente';
- } elseif (strpos($name, 'provincie') !== false) {
+ } else if (strpos($name, 'provincie') !== false) {
return 'Provincie';
- } elseif (strpos($name, 'ministerie') !== false) {
+ } else if (strpos($name, 'ministerie') !== false) {
return 'Ministerie';
} else {
- return 'Leverancier'; // Default
+ return 'Leverancier';
+ // Default.
}
- }
+ }//end determineOrganisationType()
- // ========================================================================
- // CRONJOB CONFIGURATION METHODS
- // ========================================================================
+ // ======================================================.
+ // CRONJOB CONFIGURATION METHODS.
+ // ======================================================.
/**
* Get all cronjob configurations.
*
- * Returns configuration for all registered cronjobs including their
- * user and organisation context settings.
+ * @deprecated Cronjob context is no longer needed since sync operations use _rbac: false.
+ * Will be removed in a future version.
*
* @return array The cronjob configurations indexed by job name
*/
@@ -5192,9 +5827,9 @@ public function getCronjobConfig(): array
{
try {
$configJson = $this->config->getValueString($this->_appName, 'cronjob_config', '{}');
- $config = json_decode($configJson, true);
+ $config = json_decode($configJson, true);
- if (!is_array($config)) {
+ if (is_array($config) === false) {
$config = [];
}
@@ -5205,65 +5840,74 @@ public function getCronjobConfig(): array
$result = [];
foreach ($availableCronjobs as $jobId => $jobMeta) {
$result[$jobId] = [
- 'id' => $jobId,
- 'name' => $jobMeta['name'],
- 'description' => $jobMeta['description'],
- 'interval' => $jobMeta['interval'],
- 'userId' => $config[$jobId]['userId'] ?? null,
+ 'id' => $jobId,
+ 'name' => $jobMeta['name'],
+ 'description' => $jobMeta['description'],
+ 'interval' => $jobMeta['interval'],
+ 'userId' => $config[$jobId]['userId'] ?? null,
'organisationUuid' => $config[$jobId]['organisationUuid'] ?? null,
- 'enabled' => $config[$jobId]['enabled'] ?? true,
+ 'enabled' => $config[$jobId]['enabled'] ?? true,
];
}
return [
- 'success' => true,
- 'cronjobs' => $result,
- 'timestamp' => time()
+ 'success' => true,
+ 'cronjobs' => $result,
+ 'timestamp' => time(),
];
-
} catch (\Exception $e) {
- $this->logger->error('Failed to get cronjob config', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'Failed to get cronjob config',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
- 'success' => false,
- 'message' => 'Failed to get cronjob config: ' . $e->getMessage(),
- 'cronjobs' => []
+ 'success' => false,
+ 'message' => 'Failed to get cronjob config: '.$e->getMessage(),
+ 'cronjobs' => [],
];
- }
- }
+ }//end try
+ }//end getCronjobConfig()
/**
* Get list of available cronjobs with their metadata.
*
+ * @deprecated Cronjob context is no longer needed since sync operations use _rbac: false.
+ *
* @return array List of cronjob definitions
*/
private function getAvailableCronjobs(): array
{
return [
'organization_contact_sync' => [
- 'name' => 'Organization Contact Sync',
+ 'name' => 'Organization Contact Sync',
'description' => 'Synchronizes organizations and contact persons between SoftwareCatalog objects and OpenRegister entities.',
- 'interval' => 300, // 5 minutes
- 'class' => 'OCA\\SoftwareCatalog\\BackgroundJob\\OrganizationContactSyncJob',
+ 'interval' => 300,
+ // 5 minutes.
+ 'class' => 'OCA\\SoftwareCatalog\\BackgroundJob\\OrganizationContactSyncJob',
],
];
- }
+ }//end getAvailableCronjobs()
/**
* Update cronjob configuration.
*
- * @param array $data The cronjob configuration data
- * @return array Result of the update operation
+ * @param array $data The cronjob configuration data.
+ *
+ * @return array Result of the update operation.
+ *
+ * @deprecated Cronjob context is no longer needed since sync operations use _rbac: false.
+ * Will be removed in a future version.
*/
public function updateCronjobConfig(array $data): array
{
try {
// Get existing config.
$configJson = $this->config->getValueString($this->_appName, 'cronjob_config', '{}');
- $config = json_decode($configJson, true);
+ $config = json_decode($configJson, true);
- if (!is_array($config)) {
+ if (is_array($config) === false) {
$config = [];
}
@@ -5272,24 +5916,24 @@ public function updateCronjobConfig(array $data): array
if ($jobId === null) {
return [
'success' => false,
- 'message' => 'Job ID is required'
+ 'message' => 'Job ID is required',
];
}
// Validate that the job exists.
$availableCronjobs = $this->getAvailableCronjobs();
- if (!isset($availableCronjobs[$jobId])) {
+ if (isset($availableCronjobs[$jobId]) === false) {
return [
'success' => false,
- 'message' => 'Unknown cronjob: ' . $jobId
+ 'message' => 'Unknown cronjob: '.$jobId,
];
}
// Update the config for this job.
$config[$jobId] = [
- 'userId' => $data['userId'] ?? null,
+ 'userId' => $data['userId'] ?? null,
'organisationUuid' => $data['organisationUuid'] ?? null,
- 'enabled' => $data['enabled'] ?? true,
+ 'enabled' => $data['enabled'] ?? true,
];
// Save the updated config.
@@ -5299,81 +5943,90 @@ public function updateCronjobConfig(array $data): array
json_encode($config, JSON_PRETTY_PRINT)
);
- $this->logger->info('Cronjob configuration updated', [
- 'jobId' => $jobId,
- 'userId' => $config[$jobId]['userId'],
- 'organisationUuid' => $config[$jobId]['organisationUuid']
- ]);
+ $this->logger->info(
+ 'Cronjob configuration updated',
+ [
+ 'jobId' => $jobId,
+ 'userId' => $config[$jobId]['userId'],
+ 'organisationUuid' => $config[$jobId]['organisationUuid'],
+ ]
+ );
return [
'success' => true,
'message' => 'Cronjob configuration updated successfully',
- 'config' => $config[$jobId]
+ 'config' => $config[$jobId],
];
-
} catch (\Exception $e) {
- $this->logger->error('Failed to update cronjob config', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'Failed to update cronjob config',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to update cronjob config: ' . $e->getMessage()
+ 'message' => 'Failed to update cronjob config: '.$e->getMessage(),
];
- }
- }
+ }//end try
+ }//end updateCronjobConfig()
/**
* Get cronjob context for a specific job.
*
- * This is used by the cronjob itself to get its configured user and organisation.
+ * @param string $jobId The cronjob identifier.
+ *
+ * @return array|null The context configuration or null if not configured.
*
- * @param string $jobId The cronjob identifier
- * @return array|null The context configuration or null if not configured
+ * @deprecated Cronjob context is no longer needed since sync operations use _rbac: false.
+ * Will be removed in a future version.
*/
public function getCronjobContext(string $jobId): ?array
{
try {
$configJson = $this->config->getValueString($this->_appName, 'cronjob_config', '{}');
- $config = json_decode($configJson, true);
+ $config = json_decode($configJson, true);
- if (!is_array($config) || !isset($config[$jobId])) {
+ if (is_array($config) === false || isset($config[$jobId]) === false) {
return null;
}
$jobConfig = $config[$jobId];
// Only return if both user and organisation are configured.
- if (empty($jobConfig['userId']) || empty($jobConfig['organisationUuid'])) {
+ if (empty($jobConfig['userId']) === true || empty($jobConfig['organisationUuid']) === true) {
return null;
}
return [
- 'userId' => $jobConfig['userId'],
+ 'userId' => $jobConfig['userId'],
'organisationUuid' => $jobConfig['organisationUuid'],
- 'enabled' => $jobConfig['enabled'] ?? true,
+ 'enabled' => $jobConfig['enabled'] ?? true,
];
-
} catch (\Exception $e) {
- $this->logger->error('Failed to get cronjob context', [
- 'jobId' => $jobId,
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'Failed to get cronjob context',
+ [
+ 'jobId' => $jobId,
+ 'exception' => $e->getMessage(),
+ ]
+ );
return null;
- }
- }
+ }//end try
+ }//end getCronjobContext()
/**
* Get available users for cronjob configuration.
*
- * Returns a list of users that can be selected for running cronjobs.
- * Typically limited to admin users or users in specific groups.
+ * @deprecated Cronjob context is no longer needed since sync operations use _rbac: false.
+ * Will be removed in a future version.
*
* @return array List of users with id and display name
*/
public function getAvailableUsersForCronjobs(): array
{
try {
- $userManager = $this->container->get(\OCP\IUserManager::class);
+ $userManager = $this->container->get(\OCP\IUserManager::class);
$groupManager = $this->container->get(\OCP\IGroupManager::class);
$users = [];
@@ -5383,9 +6036,9 @@ public function getAvailableUsersForCronjobs(): array
if ($adminGroup !== null) {
foreach ($adminGroup->getUsers() as $user) {
$users[] = [
- 'id' => $user->getUID(),
+ 'id' => $user->getUID(),
'displayName' => $user->getDisplayName(),
- 'email' => $user->getEMailAddress(),
+ 'email' => $user->getEMailAddress(),
];
}
}
@@ -5398,11 +6051,11 @@ public function getAvailableUsersForCronjobs(): array
foreach ($group->getUsers() as $user) {
// Avoid duplicates.
$exists = array_filter($users, fn($u) => $u['id'] === $user->getUID());
- if (empty($exists)) {
+ if (empty($exists) === true) {
$users[] = [
- 'id' => $user->getUID(),
+ 'id' => $user->getUID(),
'displayName' => $user->getDisplayName(),
- 'email' => $user->getEMailAddress(),
+ 'email' => $user->getEMailAddress(),
];
}
}
@@ -5411,36 +6064,39 @@ public function getAvailableUsersForCronjobs(): array
return [
'success' => true,
- 'users' => $users
+ 'users' => $users,
];
-
} catch (\Exception $e) {
- $this->logger->error('Failed to get available users for cronjobs', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'Failed to get available users for cronjobs',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
'success' => false,
- 'message' => 'Failed to get available users: ' . $e->getMessage(),
- 'users' => []
+ 'message' => 'Failed to get available users: '.$e->getMessage(),
+ 'users' => [],
];
- }
- }
+ }//end try
+ }//end getAvailableUsersForCronjobs()
/**
* Get available organisations for cronjob configuration.
*
- * Returns a list of organisations that can be selected for running cronjobs.
+ * @deprecated Cronjob context is no longer needed since sync operations use _rbac: false.
+ * Will be removed in a future version.
*
* @return array List of organisations with uuid and name
*/
public function getAvailableOrganisationsForCronjobs(): array
{
try {
- if (!in_array('openregister', $this->appManager->getInstalledApps())) {
+ if (in_array('openregister', $this->appManager->getInstalledApps()) === false) {
return [
- 'success' => false,
- 'message' => 'OpenRegister is not installed',
- 'organisations' => []
+ 'success' => false,
+ 'message' => 'OpenRegister is not installed',
+ 'organisations' => [],
];
}
@@ -5452,27 +6108,28 @@ public function getAvailableOrganisationsForCronjobs(): array
$result = [];
foreach ($organisations as $org) {
$result[] = [
- 'uuid' => $org->getUuid(),
- 'name' => $org->getName(),
+ 'uuid' => $org->getUuid(),
+ 'name' => $org->getName(),
'description' => $org->getDescription(),
];
}
return [
- 'success' => true,
- 'organisations' => $result
+ 'success' => true,
+ 'organisations' => $result,
];
-
} catch (\Exception $e) {
- $this->logger->error('Failed to get available organisations for cronjobs', [
- 'exception' => $e->getMessage()
- ]);
+ $this->logger->error(
+ 'Failed to get available organisations for cronjobs',
+ [
+ 'exception' => $e->getMessage(),
+ ]
+ );
return [
- 'success' => false,
- 'message' => 'Failed to get available organisations: ' . $e->getMessage(),
- 'organisations' => []
+ 'success' => false,
+ 'message' => 'Failed to get available organisations: '.$e->getMessage(),
+ 'organisations' => [],
];
- }
- }
-
-}
+ }//end try
+ }//end getAvailableOrganisationsForCronjobs()
+}//end class
diff --git a/lib/Service/SoftwareCatalogue/ContactPersonHandler.php b/lib/Service/SoftwareCatalogue/ContactPersonHandler.php
index 8276a969..73aef9b4 100644
--- a/lib/Service/SoftwareCatalogue/ContactPersonHandler.php
+++ b/lib/Service/SoftwareCatalogue/ContactPersonHandler.php
@@ -10,7 +10,6 @@
* @package OCA\SoftwareCatalog\Service\SoftwareCatalogue
* @author Conduction b.v.
* @license AGPL-3.0-or-later https://www.gnu.org/licenses/agpl-3.0.html
- * @version 1.0.0
* @link https://github.com/ConductionNL/SoftwareCatalog
*/
@@ -31,13 +30,12 @@
use OCA\SoftwareCatalog\Service\SymfonyEmailService;
/**
- * Handler for contact person-related operations
+ * Handler for contact person-related operations.
*
* @category Handler
* @package OCA\SoftwareCatalog\Service\SoftwareCatalogue
* @author Conduction b.v.
* @license AGPL-3.0-or-later https://www.gnu.org/licenses/agpl-3.0.html
- * @version 1.0.0
* @link https://github.com/ConductionNL/SoftwareCatalog
*/
class ContactPersonHandler
@@ -45,28 +43,28 @@ class ContactPersonHandler
/**
* ContactPersonHandler constructor
*
- * @param IUserManager $_userManager User manager interface
- * @param ISecureRandom $_secureRandom Secure random generator
- * @param IGroupManager $_groupManager Group manager interface
- * @param IAppConfig $_config Config interface
- * @param ContainerInterface $_container Container interface
- * @param IAppManager $_appManager App manager interface
- * @param LoggerInterface $_logger Logger interface
- * @param SymfonyEmailService $_emailService Email service
+ * @param IUserManager $_userManager User manager interface.
+ * @param ISecureRandom $_secureRandom Secure random generator.
+ * @param IGroupManager $_groupManager Group manager interface.
+ * @param IAppConfig $_config Config interface.
+ * @param ContainerInterface $_container Container interface.
+ * @param IAppManager $_appManager App manager interface.
+ * @param LoggerInterface $_logger Logger interface.
+ * @param SymfonyEmailService $_emailService Email service.
+ * @param IConfig $config Config interface.
*/
public function __construct(
- private readonly IUserManager $_userManager,
- private readonly ISecureRandom $_secureRandom,
- private readonly IGroupManager $_groupManager,
- private readonly IAppConfig $_config,
- private readonly ContainerInterface $_container,
- private readonly IAppManager $_appManager,
- private readonly LoggerInterface $_logger,
+ private readonly IUserManager $_userManager,
+ private readonly ISecureRandom $_secureRandom,
+ private readonly IGroupManager $_groupManager,
+ private readonly IAppConfig $_config,
+ private readonly ContainerInterface $_container,
+ private readonly IAppManager $_appManager,
+ private readonly LoggerInterface $_logger,
private readonly SymfonyEmailService $_emailService,
- private readonly IConfig $config,
- )
- {
- }
+ private readonly IConfig $config,
+ ) {
+ }//end __construct()
/**
* Gets the OpenRegister ObjectService if available
@@ -74,15 +72,14 @@ public function __construct(
* @return \OCA\OpenRegister\Service\ObjectService|null ObjectService instance or null
* @throws \RuntimeException If service is not available
*/
- private function _getObjectService(): ?\OCA\OpenRegister\Service\ObjectService
+ private function getObjectService(): ?\OCA\OpenRegister\Service\ObjectService
{
- if (in_array('openregister', $this->_appManager->getInstalledApps())) {
+ if (in_array('openregister', $this->_appManager->getInstalledApps()) === true) {
return $this->_container->get('OCA\OpenRegister\Service\ObjectService');
}
throw new \RuntimeException('OpenRegister service is not available.');
- }
-
+ }//end getObjectService()
/**
* Generates a username from contact data with fallback strategies
@@ -94,370 +91,526 @@ private function _getObjectService(): ?\OCA\OpenRegister\Service\ObjectService
public function generateUsernameFromContactData(array $contactData): string
{
-
- $voornaam = $contactData['voornaam'] ?? '';
+ $voornaam = $contactData['voornaam'] ?? '';
$tussenvoegsel = $contactData['tussenvoegsel'] ?? '';
- $achternaam = $contactData['achternaam'] ?? '';
- $email = $contactData['email'] ?? $contactData['e-mailadres'] ?? '';
-
-
- // Strategy 1: full email address (PRIORITY)
- if (!empty($email) && strpos($email, '@') !== false) {
- $username = strtolower($email);
- if ($this->isValidUsername($username)) {
+ $achternaam = $contactData['achternaam'] ?? '';
+ $email = $contactData['email'] ?? $contactData['e-mailadres'] ?? '';
+
+ // Strategy 1: full email address (PRIORITY).
+ // Sanitize the email first to strip subaddressing (+tag) and invalid chars.
+ if (empty($email) === false && strpos($email, '@') !== false) {
+ $username = $this->sanitizeEmailForUsername(email: $email);
+ if ($this->isValidUsername(username: $username) === true) {
return $username;
}
}
- // Strategy 2: firstname.lastname (fallback)
- if (!empty($voornaam) && !empty($achternaam)) {
- // Strip spaces and non-alphanumeric chars from name parts
- $cleanVoornaam = preg_replace('/[^a-z0-9]/', '', strtolower($voornaam));
+ // Strategy 2: firstname.lastname (fallback).
+ if (empty($voornaam) === false && empty($achternaam) === false) {
+ // Strip spaces and non-alphanumeric chars from name parts.
+ $cleanVoornaam = preg_replace('/[^a-z0-9]/', '', strtolower($voornaam));
$cleanAchternaam = preg_replace('/[^a-z0-9]/', '', strtolower($achternaam));
- if (!empty($cleanVoornaam) && !empty($cleanAchternaam)) {
- $username = $cleanVoornaam . '.' . $cleanAchternaam;
- if ($this->isValidUsername($username)) {
+ if (empty($cleanVoornaam) === false && empty($cleanAchternaam) === false) {
+ $username = $cleanVoornaam.'.'.$cleanAchternaam;
+ if ($this->isValidUsername(username: $username) === true) {
return $username;
}
}
}
- // Strategy 3: firstnamelastname (fallback)
- if (!empty($voornaam) && !empty($achternaam)) {
- $cleanVoornaam = preg_replace('/[^a-z0-9]/', '', strtolower($voornaam));
+ // Strategy 3: firstnamelastname (fallback).
+ if (empty($voornaam) === false && empty($achternaam) === false) {
+ $cleanVoornaam = preg_replace('/[^a-z0-9]/', '', strtolower($voornaam));
$cleanAchternaam = preg_replace('/[^a-z0-9]/', '', strtolower($achternaam));
- if (!empty($cleanVoornaam) && !empty($cleanAchternaam)) {
- $username = $cleanVoornaam . $cleanAchternaam;
- if ($this->isValidUsername($username)) {
+ if (empty($cleanVoornaam) === false && empty($cleanAchternaam) === false) {
+ $username = $cleanVoornaam.$cleanAchternaam;
+ if ($this->isValidUsername(username: $username) === true) {
return $username;
}
}
}
- // Strategy 4: timestamp fallback
- $username = 'user' . time();
- if ($this->isValidUsername($username)) {
+ // Strategy 4: timestamp fallback.
+ $username = 'user'.time();
+ if ($this->isValidUsername(username: $username) === true) {
return $username;
}
- // If all strategies fail, log error and return empty string
+ // If all strategies fail, log error and return empty string.
$this->_logger->error('All username generation strategies failed', ['contactData' => $contactData]);
return '';
- }
+ }//end generateUsernameFromContactData()
/**
- * Validates if a username meets Nextcloud requirements
+ * Validates if a username meets Nextcloud requirements.
+ *
+ * @param string $username The username to validate.
+ *
+ * @return bool True if valid, false otherwise.
*/
private function isValidUsername(string $username): bool
{
- if (empty($username)) {
+ if (empty($username) === true) {
return false;
}
- // Basic validation rules (adjust based on your Nextcloud configuration)
+ // Basic validation rules (adjust based on your Nextcloud configuration).
if (strlen($username) < 3 || strlen($username) > 64) {
return false;
}
- // Must start with alphanumeric
- if (!preg_match('/^[a-z0-9]/', $username)) {
+ // Must start with alphanumeric.
+ if (preg_match('/^[a-z0-9]/', $username) === 0) {
return false;
}
- // Only allow alphanumeric, dots, underscores, dashes, and @ (matching Nextcloud's allowed chars)
- if (!preg_match('/^[a-z0-9._@\-]+$/', $username)) {
+ // Only allow alphanumeric, dots, underscores, dashes, and @ (matching Nextcloud's allowed chars).
+ if (preg_match('/^[a-z0-9._@\-]+$/', $username) === 0) {
return false;
}
return true;
- }
+ }//end isValidUsername()
+
+ /**
+ * Sanitizes an email address for use as a Nextcloud username.
+ *
+ * Strips subaddressing (the +tag part) from the local part of the email,
+ * since Nextcloud does not allow + in usernames. For example,
+ * "user+tag@example.com" becomes "user@example.com".
+ *
+ * @param string $email The email address to sanitize.
+ *
+ * @return string The sanitized email suitable for use as a username.
+ */
+ public function sanitizeEmailForUsername(string $email): string
+ {
+ $lowered = strtolower(trim($email));
+
+ // Strip subaddressing (+tag) from the local part of the email.
+ if (strpos($lowered, '+') !== false && strpos($lowered, '@') !== false) {
+ $parts = explode(separator: '@', string: $lowered, limit: 2);
+ $localPart = preg_replace(pattern: '/\+.*$/', replacement: '', subject: $parts[0]);
+ $lowered = $localPart.'@'.$parts[1];
+ }
+
+ // Remove any remaining characters not allowed in Nextcloud usernames.
+ $lowered = preg_replace(pattern: '/[^a-z0-9._@\-]/', replacement: '', subject: $lowered);
+
+ return $lowered;
+
+ }//end sanitizeEmailForUsername()
/**
* Validates an email address for use as a Nextcloud username.
* Returns null if valid, or an error message string if invalid.
*
- * @param string $email The email address to validate
- * @return string|null Null if valid, error message if invalid
+ * If the email contains subaddressing (a +tag), it is stripped before
+ * validation since Nextcloud does not support + in usernames. The
+ * sanitized form will be used as the actual username.
+ *
+ * @param string $email The email address to validate.
+ *
+ * @return string|null Null if valid, error message if invalid.
*/
public function validateEmailForUsername(string $email): ?string
{
- if (empty($email)) {
- return 'No email address found. The contact person must have a valid email address (in the "email" or "e-mailadres" field) to be activated.';
+ if (empty($email) === true) {
+ return 'No email address found on the contact person.';
}
- if (strpos($email, '@') === false) {
+ if (strpos(haystack: $email, needle: '@') === false) {
return "The email address \"{$email}\" is not a valid email address (missing @).";
}
- $lowered = strtolower($email);
-
- // Find invalid characters
- $invalidChars = preg_replace('/[a-z0-9._@\-]/', '', $lowered);
- if (!empty($invalidChars)) {
- $uniqueChars = implode(' ', array_unique(str_split($invalidChars)));
- return "The email address \"{$email}\" contains characters that are not allowed in a Nextcloud username: {$uniqueChars}. Only letters (a-z), numbers (0-9), dots (.), underscores (_), dashes (-) and @ are allowed. Please correct the email address on the contact person before activating.";
- }
+ // Sanitize the email by stripping subaddressing and removing invalid chars.
+ $sanitized = $this->sanitizeEmailForUsername(email: $email);
- if (strlen($lowered) < 3) {
+ if (strlen($sanitized) < 3) {
return "The email address \"{$email}\" is too short to be used as a username (minimum 3 characters).";
}
- if (strlen($lowered) > 64) {
+ if (strlen($sanitized) > 64) {
return "The email address \"{$email}\" is too long to be used as a username (maximum 64 characters).";
}
+ // Validate the sanitized result has no remaining invalid characters.
+ $invalidChars = preg_replace(pattern: '/[a-z0-9._@\-]/', replacement: '', subject: $sanitized);
+ if (empty($invalidChars) === false) {
+ $uniqueChars = implode(
+ separator: ' ',
+ array: array_unique(str_split($invalidChars)),
+ );
+ return "Invalid username characters: {$uniqueChars}.";
+ }
+
return null;
- }
+
+ }//end validateEmailForUsername()
/**
- * Ensures username is unique by adding counter if needed
+ * Ensures username is unique by adding counter if needed.
+ *
+ * @param string $username The username to check.
+ *
+ * @return string The unique username.
*/
private function ensureUniqueUsername(string $username): string
{
$originalUsername = $username;
- $counter = 1;
+ $counter = 1;
- while ($this->_userManager->userExists($username)) {
- $username = $originalUsername . $counter;
+ while ($this->_userManager->userExists($username) === true) {
+ $username = $originalUsername.$counter;
$counter++;
-
- // Safety check to prevent infinite loop
+ // Safety check to prevent infinite loop.
if ($counter > 9999) {
- $username = $originalUsername . uniqid();
+ $username = $originalUsername.uniqid();
break;
}
}
return $username;
- }
+ }//end ensureUniqueUsername()
/**
- * Creates a user account for a contact person
+ * Creates a user account for a contact person.
*
- * @param object $contactpersoonObject The contact person object
+ * @param object $contactpersoonObject The contact person object.
+ * @param bool $isFirstContact Whether this is the first contact.
*
- * @return \OCP\IUser|null The created user or null if failed
+ * @return \OCP\IUser|null The created user or null if failed.
*/
- public function createUserAccount(object $contactpersoonObject, bool $isFirstContact = false): ?\OCP\IUser
+ public function createUserAccount(object $contactpersoonObject, bool $isFirstContact=false): ?\OCP\IUser
{
$startTime = microtime(true);
try {
- $objectData = $contactpersoonObject->getObject();
- $contactId = $contactpersoonObject->getId();
- $email = $objectData['email'] ?? $objectData['e-mailadres'] ?? '';
+ $objectData = $contactpersoonObject->getObject();
+ $contactId = $contactpersoonObject->getId();
+ $email = $objectData['email'] ?? $objectData['e-mailadres'] ?? '';
$organizationUuid = $objectData['organisation'] ?? $objectData['organisatie'] ?? '';
- $this->_logger->debug('User account creation started', [
- 'app' => 'softwarecatalog',
- 'contactId' => $contactId,
- 'email' => $email,
- 'organizationUuid' => $organizationUuid,
- 'isFirstContact' => $isFirstContact,
- ]);
-
- if (empty($email)) {
- $this->_logger->error('❌ USER CREATION FAILED - NO EMAIL', [
- 'app' => 'softwarecatalog',
- 'contactpersoonId' => $contactId
- ]);
+ $this->_logger->debug(
+ 'User account creation started',
+ [
+ 'app' => 'softwarecatalog',
+ 'contactId' => $contactId,
+ 'email' => $email,
+ 'organizationUuid' => $organizationUuid,
+ 'isFirstContact' => $isFirstContact,
+ ]
+ );
+
+ if (empty($email) === true) {
+ $this->_logger->error(
+ '❌ USER CREATION FAILED - NO EMAIL',
+ [
+ 'app' => 'softwarecatalog',
+ 'contactpersoonId' => $contactId,
+ ]
+ );
return null;
}
- // Generate username first to check both email and username existence
+ // Generate username first to check both email and username existence.
$username = $objectData['username'] ?? '';
- if (empty($username)) {
- $this->_logger->info('[USER] Step 1: Generating username', [
- 'contactId' => $contactId,
- 'email' => $email
- ]);
- $username = $this->generateUsernameFromContactData($objectData);
- $this->_logger->critical('📝 USERNAME GENERATED', [
- 'app' => 'softwarecatalog',
- 'contactId' => $contactId,
- 'generatedUsername' => $username,
- 'email' => $email
- ]);
+ if (empty($username) === true) {
+ $this->_logger->info(
+ '[USER] Step 1: Generating username',
+ [
+ 'contactId' => $contactId,
+ 'email' => $email,
+ ]
+ );
+ $username = $this->generateUsernameFromContactData(contactData: $objectData);
+ $this->_logger->critical(
+ '📝 USERNAME GENERATED',
+ [
+ 'app' => 'softwarecatalog',
+ 'contactId' => $contactId,
+ 'generatedUsername' => $username,
+ 'email' => $email,
+ ]
+ );
}
- // Check if user already exists by email
- $this->_logger->info('[USER] Step 2: Checking existing user by email', [
- 'email' => $email
- ]);
- if ($this->_userManager->userExists($email)) {
- $this->_logger->critical('♻️ USER EXISTS BY EMAIL', [
- 'app' => 'softwarecatalog',
- 'email' => $email,
- 'contactpersoonId' => $contactId
- ]);
-
+ // Check if user already exists by email.
+ $this->_logger->info(
+ '[USER] Step 2: Checking existing user by email',
+ [
+ 'email' => $email,
+ ]
+ );
+ if ($this->_userManager->userExists($email) === true) {
+ $this->_logger->critical(
+ '♻️ USER EXISTS BY EMAIL',
+ [
+ 'app' => 'softwarecatalog',
+ 'email' => $email,
+ 'contactpersoonId' => $contactId,
+ ]
+ );
+
$existingUser = $this->_userManager->get($email);
- if ($existingUser) {
- // Store organization UUID for existing user
- if (!empty($organizationUuid)) {
- $this->storeUserOrganizationUuid($existingUser, $organizationUuid);
+ if (empty($existingUser) === false) {
+ // Store organization UUID for existing user.
+ if (empty($organizationUuid) === false) {
+ $this->storeUserOrganizationUuid(user: $existingUser, organizationUuid: $organizationUuid);
}
- // Store contact name fields for existing user (update if contact data changed)
- $this->storeContactNameFields($existingUser, $objectData);
+ // Store contact name fields for existing user (update if contact data changed).
+ $this->storeContactNameFields(user: $existingUser, contactData: $objectData);
- // Update groups for existing user
- $this->assignUserGroups($existingUser, $objectData, $isFirstContact);
+ // Update groups for existing user.
+ $this->assignUserGroups(user: $existingUser, objectData: $objectData, isFirstContact: $isFirstContact);
- $this->_logger->critical('✅ EXISTING USER UPDATED', [
- 'app' => 'softwarecatalog',
- 'username' => $existingUser->getUID(),
- 'email' => $email,
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->critical(
+ '✅ EXISTING USER UPDATED',
+ [
+ 'app' => 'softwarecatalog',
+ 'username' => $existingUser->getUID(),
+ 'email' => $email,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return $existingUser;
- }
- }
+ }//end if
+ }//end if
- // Check if user already exists by username
- $this->_logger->info('[USER] Step 3: Checking existing user by username', [
- 'username' => $username
- ]);
+ // Check if user already exists by username.
+ $this->_logger->info(
+ '[USER] Step 3: Checking existing user by username',
+ [
+ 'username' => $username,
+ ]
+ );
$existingUserByUsername = $this->_userManager->get($username);
- if ($existingUserByUsername) {
- $this->_logger->critical('♻️ USER EXISTS BY USERNAME', [
- 'app' => 'softwarecatalog',
- 'username' => $username,
- 'contactpersoonId' => $contactId
- ]);
+ if (empty($existingUserByUsername) === false) {
+ $this->_logger->critical(
+ '♻️ USER EXISTS BY USERNAME',
+ [
+ 'app' => 'softwarecatalog',
+ 'username' => $username,
+ 'contactpersoonId' => $contactId,
+ ]
+ );
- // Store organization UUID for existing user
- if (!empty($organizationUuid)) {
- $this->storeUserOrganizationUuid($existingUserByUsername, $organizationUuid);
+ // Store organization UUID for existing user.
+ if (empty($organizationUuid) === false) {
+ $this->storeUserOrganizationUuid(user: $existingUserByUsername, organizationUuid: $organizationUuid);
}
- // Store contact name fields for existing user (update if contact data changed)
- $this->storeContactNameFields($existingUserByUsername, $objectData);
+ // Store contact name fields for existing user (update if contact data changed).
+ $this->storeContactNameFields(user: $existingUserByUsername, contactData: $objectData);
- // Update groups for existing user
- $this->assignUserGroups($existingUserByUsername, $objectData, $isFirstContact);
+ // Update groups for existing user.
+ $this->assignUserGroups(user: $existingUserByUsername, objectData: $objectData, isFirstContact: $isFirstContact);
- $this->_logger->critical('✅ EXISTING USER UPDATED BY USERNAME', [
- 'app' => 'softwarecatalog',
- 'username' => $username,
- 'email' => $existingUserByUsername->getEMailAddress(),
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->critical(
+ '✅ EXISTING USER UPDATED BY USERNAME',
+ [
+ 'app' => 'softwarecatalog',
+ 'username' => $username,
+ 'email' => $existingUserByUsername->getEMailAddress(),
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return $existingUserByUsername;
- }
+ }//end if
- // Create new user account
- $this->_logger->critical('🚀 CREATING NEW USER ACCOUNT', [
- 'app' => 'softwarecatalog',
- 'username' => $username,
- 'email' => $email,
- 'contactId' => $contactId
- ]);
+ // Create new user account.
+ $this->_logger->critical(
+ '🚀 CREATING NEW USER ACCOUNT',
+ [
+ 'app' => 'softwarecatalog',
+ 'username' => $username,
+ 'email' => $email,
+ 'contactId' => $contactId,
+ ]
+ );
$randomPw = $this->_secureRandom->generate(length: 12);
- $user = $this->_userManager->createUser(uid: $username, password: $randomPw);
+ $user = $this->_userManager->createUser(uid: $username, password: $randomPw);
- if ($user) {
- $this->_logger->critical('🎊 NEW USER ACCOUNT CREATED', [
- 'app' => 'softwarecatalog',
- 'username' => $username,
- 'email' => $email,
- 'contactId' => $contactId,
- 'userId' => $user->getUID()
- ]);
-
- // Set user details
- $this->_logger->info('[USER] Step 4: Setting user details', [
- 'username' => $username
- ]);
+ if (empty($user) === false) {
+ $this->_logger->critical(
+ '🎊 NEW USER ACCOUNT CREATED',
+ [
+ 'app' => 'softwarecatalog',
+ 'username' => $username,
+ 'email' => $email,
+ 'contactId' => $contactId,
+ 'userId' => $user->getUID(),
+ ]
+ );
+
+ // Fire-and-forget filesystem pre-warm in a background process.
+ // This replicates Session::prepareUserLogin() (setupFS, copySkeleton,.
+ // updateLastLoginTimestamp) so the user's first login is instant.
+ // Uses exec('... &') for true async — returns immediately, the forked.
+ // process does the ~5s work without blocking the admin's request.
+ try {
+ $phpBin = PHP_BINARY;
+ if (empty($phpBin) === true) {
+ $phpBin = 'php';
+ }
+
+ $serverRoot = \OC::$SERVERROOT;
+ $safeUser = escapeshellarg($username);
+ $exportedUser = var_export($username, true);
+ $requirePart = 'require "'.$serverRoot.'/lib/base.php";';
+ $setupPart = ' \OC_Util::setupFS('.$exportedUser.');';
+ $folderPart = ' $f = \OC::$server->getUserFolder('.$exportedUser.');';
+ $skelPart = ' \OC_Util::copySkeleton('.$exportedUser.', $f);';
+ // phpcs:ignore Generic.Files.LineLength.TooLong
+ $loginPart = ' \OC::$server->get(\OCP\IUserManager::class)->get('.$exportedUser.')->updateLastLoginTimestamp();';
+ $script = $requirePart.$setupPart.$folderPart.$skelPart.$loginPart;
+ $cmd = sprintf(
+ '%s -r %s > /dev/null 2>&1 &',
+ escapeshellarg($phpBin),
+ escapeshellarg($script)
+ );
+ exec($cmd);
+ } catch (\Exception $e) {
+ $this->_logger->warning(
+ 'Filesystem pre-warm exec failed for '.$username,
+ [
+ 'app' => 'softwarecatalog',
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+
+ // Set user details.
+ $this->_logger->info(
+ '[USER] Step 4: Setting user details',
+ [
+ 'username' => $username,
+ ]
+ );
$user->setEMailAddress($email);
- $displayName = $this->getDisplayNameFromContactData($objectData);
+ $displayName = $this->getDisplayNameFromContactData(contactData: $objectData);
$user->setDisplayName($displayName);
- // Store contact name fields in Nextcloud user config for /me endpoint
- $this->storeContactNameFields($user, $objectData);
+ // Store contact name fields in Nextcloud user config for /me endpoint.
+ $this->storeContactNameFields(user: $user, contactData: $objectData);
- $this->_logger->critical('📋 USER DETAILS SET', [
- 'app' => 'softwarecatalog',
- 'username' => $username,
- 'email' => $email,
- 'displayName' => $displayName,
- 'firstName' => $objectData['voornaam'] ?? '',
- 'middleName' => $objectData['tussenvoegsel'] ?? '',
- 'lastName' => $objectData['achternaam'] ?? '',
- 'functie' => $objectData['functie'] ?? ''
- ]);
-
- // Store organization UUID in user config for OpenConnector access
- if (!empty($organizationUuid)) {
- $this->_logger->info('[USER] Step 5: Storing organization UUID', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
- $this->storeUserOrganizationUuid($user, $organizationUuid);
+ $this->_logger->critical(
+ '📋 USER DETAILS SET',
+ [
+ 'app' => 'softwarecatalog',
+ 'username' => $username,
+ 'email' => $email,
+ 'displayName' => $displayName,
+ 'firstName' => $objectData['voornaam'] ?? '',
+ 'middleName' => $objectData['tussenvoegsel'] ?? '',
+ 'lastName' => $objectData['achternaam'] ?? '',
+ 'functie' => $objectData['functie'] ?? '',
+ ]
+ );
+
+ // Store organization UUID in user config for OpenConnector access.
+ if (empty($organizationUuid) === false) {
+ $this->_logger->info(
+ '[USER] Step 5: Storing organization UUID',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+ $this->storeUserOrganizationUuid(user: $user, organizationUuid: $organizationUuid);
}
- // Set user groups based on roles and organization
- $this->_logger->info('[USER] Step 6: Assigning user groups', [
- 'username' => $username,
- 'isFirstContact' => $isFirstContact
- ]);
- $this->assignUserGroups($user, $objectData, $isFirstContact);
+ // Set user groups based on roles and organization.
+ $this->_logger->info(
+ '[USER] Step 6: Assigning user groups',
+ [
+ 'username' => $username,
+ 'isFirstContact' => $isFirstContact,
+ ]
+ );
+ $assignedRole = $this->assignUserGroups(user: $user, objectData: $objectData, isFirstContact: $isFirstContact);
- // Update contactpersoon with username
+ // Update contactpersoon with username and auto-assigned role.
$objectData['username'] = $username;
+
+ // Populate the rollen field if a role was assigned and rollen is empty.
+ $currentRollen = $objectData['rollen'] ?? [];
+ if (empty($assignedRole) === false && (empty($currentRollen) === true || is_array($currentRollen) === false)) {
+ $objectData['rollen'] = [$assignedRole];
+ $this->_logger->info(
+ 'Auto-populated rollen field on contactpersoon',
+ [
+ 'username' => $username,
+ 'assignedRole' => $assignedRole,
+ ]
+ );
+ }
+
$contactpersoonObject->setObject($objectData);
- // Send user creation email
- $this->_logger->info('[USER] Step 7: Sending user creation email', [
- 'username' => $username,
- 'email' => $email
- ]);
- $this->sendUserCreationEmail($user, $objectData);
+ // Send user creation email.
+ $this->_logger->info(
+ '[USER] Step 7: Sending user creation email',
+ [
+ 'username' => $username,
+ 'email' => $email,
+ ]
+ );
+ $this->sendUserCreationEmail(user: $user, objectData: $objectData);
$creationTime = round(microtime(true) - $startTime, 3);
- $this->_logger->critical('🎉 USER ACCOUNT CREATION COMPLETED', [
- 'app' => 'softwarecatalog',
- 'contactpersoonId' => $contactId,
- 'username' => $username,
- 'email' => $email,
- 'displayName' => $displayName,
- 'organizationUuid' => $organizationUuid,
- 'creationTime' => $creationTime . 's'
- ]);
+ $this->_logger->critical(
+ '🎉 USER ACCOUNT CREATION COMPLETED',
+ [
+ 'app' => 'softwarecatalog',
+ 'contactpersoonId' => $contactId,
+ 'username' => $username,
+ 'email' => $email,
+ 'displayName' => $displayName,
+ 'organizationUuid' => $organizationUuid,
+ 'creationTime' => $creationTime.'s',
+ ]
+ );
return $user;
} else {
- $this->_logger->error('❌ USER CREATION RETURNED NULL', [
- 'app' => 'softwarecatalog',
- 'username' => $username,
- 'email' => $email,
- 'contactpersoonId' => $contactId,
- 'note' => 'No exception thrown but createUser returned null'
- ]);
- }
+ $this->_logger->error(
+ '❌ USER CREATION RETURNED NULL',
+ [
+ 'app' => 'softwarecatalog',
+ 'username' => $username,
+ 'email' => $email,
+ 'contactpersoonId' => $contactId,
+ 'note' => 'No exception thrown but createUser returned null',
+ ]
+ );
+ }//end if
return null;
-
} catch (\Exception $e) {
- $this->_logger->error('💥 USER CREATION EXCEPTION', [
- 'app' => 'softwarecatalog',
- 'contactpersoonId' => $contactpersoonObject->getId(),
- 'email' => $objectData['email'] ?? $objectData['e-mailadres'] ?? 'unknown',
- 'username' => $username ?? 'unknown',
- 'exception' => $e->getMessage(),
- 'exception_class' => get_class($e),
- 'exception_code' => $e->getCode(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->_logger->error(
+ '💥 USER CREATION EXCEPTION',
+ [
+ 'app' => 'softwarecatalog',
+ 'contactpersoonId' => $contactpersoonObject->getId(),
+ 'email' => $objectData['email'] ?? $objectData['e-mailadres'] ?? 'unknown',
+ 'username' => $username ?? 'unknown',
+ 'exception' => $e->getMessage(),
+ 'exception_class' => get_class($e),
+ 'exception_code' => $e->getCode(),
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
return null;
- }
- }
+ }//end try
+ }//end createUserAccount()
/**
* Assigns user groups based on organization type and roles
@@ -468,26 +621,29 @@ public function createUserAccount(object $contactpersoonObject, bool $isFirstCon
*
* @return void
*/
+
/**
* Assign user to appropriate groups based on their role and organization.
- *
+ *
* Users are NOT added to generic groups or organization-specific groups.
* Users are tied to organization entities in OpenRegister instead.
- *
- * @param \OCP\IUser $user The user to assign groups to.
- * @param array $objectData The contactpersoon object data.
- * @param bool $isFirstContact Whether this is the first contact of the organization.
- *
- * @return void
+ *
+ * @param \OCP\IUser $user The user to assign groups to.
+ * @param array $objectData The contactpersoon object data.
+ * @param bool $isFirstContact Whether this is the first contact of the organization.
+ *
+ * @return string
*/
- private function assignUserGroups(\OCP\IUser $user, array $objectData, bool $isFirstContact = false): void
+ private function assignUserGroups(\OCP\IUser $user, array $objectData, bool $isFirstContact=false): string
{
+ $assignedRole = '';
+
try {
- $roles = $objectData['roles'] ?? [];
+ $roles = $objectData['rollen'] ?? $objectData['roles'] ?? [];
$organizationId = $objectData['organisation'] ?? $objectData['organisatie'] ?? '';
// Ensure roles is an array.
- if (!is_array($roles)) {
+ if (is_array($roles) === false) {
$roles = [$roles];
}
@@ -495,76 +651,110 @@ private function assignUserGroups(\OCP\IUser $user, array $objectData, bool $isF
$settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
// Add user to organization admin groups if this is the first contact.
- if ($isFirstContact) {
+ if (empty($isFirstContact) === false) {
$organizationAdminGroups = $settingsService->getOrganizationAdminGroups();
foreach ($organizationAdminGroups as $groupName) {
- $this->addUserToGroupWithCheck($user, $groupName, 'organization-admin');
+ $this->addUserToGroupWithCheck(user: $user, groupName: $groupName, type: 'organization-admin');
}
-
+
$this->_logger->info(
'Assigned organization admin groups to first contact',
[
- 'username' => $user->getUID(),
+ 'username' => $user->getUID(),
'organizationId' => $organizationId,
- 'adminGroups' => $organizationAdminGroups
+ 'adminGroups' => $organizationAdminGroups,
]
);
}
// Assign role based on organization type.
- if (!empty($organizationId)) {
- $organizationType = $this->getOrganizationType((string)$organizationId);
- $roleGroup = $this->getRoleGroupByOrganizationType($organizationType);
-
- if (!empty($roleGroup)) {
- $this->addUserToGroupWithCheck($user, $roleGroup, 'organization-type-role');
-
+ if (empty($organizationId) === false) {
+ $organizationType = $this->getOrganizationType(organizationId: (string) $organizationId);
+ $roleGroup = $this->getRoleGroupByOrganizationType(organizationType: $organizationType);
+
+ if (empty($roleGroup) === false) {
+ $this->addUserToGroupWithCheck(user: $user, groupName: $roleGroup, type: 'organization-type-role');
+
+ // Map the lowercase group name to the title-case enum value for the rollen field.
+ $assignedRole = $this->mapGroupNameToRollenEnum(groupName: $roleGroup);
+
$this->_logger->info(
'Assigned role based on organization type',
[
- 'username' => $user->getUID(),
- 'organizationId' => $organizationId,
+ 'username' => $user->getUID(),
+ 'organizationId' => $organizationId,
'organizationType' => $organizationType,
- 'assignedRole' => $roleGroup
+ 'assignedRole' => $roleGroup,
+ 'rollenEnumValue' => $assignedRole,
]
);
} else {
$this->_logger->warning(
'No role mapping found for organization type',
[
- 'username' => $user->getUID(),
- 'organizationId' => $organizationId,
- 'organizationType' => $organizationType
+ 'username' => $user->getUID(),
+ 'organizationId' => $organizationId,
+ 'organizationType' => $organizationType,
]
);
- }
- }
+ }//end if
+ }//end if
// Users are now tied to organisation entities in OpenRegister.
// No need to add to organization-specific groups.
+ if ($isFirstContact === true) {
+ $organizationAdminGroupsValue = ($organizationAdminGroups ?? []);
+ } else {
+ $organizationAdminGroupsValue = [];
+ }
$this->_logger->info(
'Successfully assigned user groups based on organization type',
[
- 'username' => $user->getUID(),
- 'isFirstContact' => $isFirstContact,
- 'organizationAdminGroups' => $isFirstContact ? ($organizationAdminGroups ?? []) : [],
- 'organizationId' => $organizationId,
- 'roleGroup' => $roleGroup ?? 'none',
- 'organizationType' => $organizationType ?? 'unknown'
+ 'username' => $user->getUID(),
+ 'isFirstContact' => $isFirstContact,
+ 'organizationAdminGroups' => $organizationAdminGroupsValue,
+ 'organizationId' => $organizationId,
+ 'roleGroup' => $roleGroup ?? 'none',
+ 'organizationType' => $organizationType ?? 'unknown',
+ 'assignedRollenEnum' => $assignedRole,
]
);
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to assign user groups: ' . $e->getMessage(),
+ 'Failed to assign user groups: '.$e->getMessage(),
[
- 'username' => $user->getUID(),
- 'exception' => $e
+ 'username' => $user->getUID(),
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+
+ return $assignedRole;
+ }//end assignUserGroups()
+
+ /**
+ * Maps a lowercase group name to the title-case rollen enum value
+ *
+ * The contactpersoon schema uses title-case enum values (e.g., "Gebruik-beheerder")
+ * while Nextcloud groups use lowercase (e.g., "gebruik-beheerder").
+ *
+ * @param string $groupName The lowercase group name
+ *
+ * @return string The title-case enum value for the rollen field
+ */
+ private function mapGroupNameToRollenEnum(string $groupName): string
+ {
+ $mapping = [
+ 'aanbod-beheerder' => 'Aanbod-beheerder',
+ 'gebruik-beheerder' => 'Gebruik-beheerder',
+ 'gebruik-raadpleger' => 'Gebruik-raadpleger',
+ 'functioneel-beheerder' => 'Functioneel-beheerder',
+ 'organisatie-beheerder' => 'Organisatie-beheerder',
+ ];
+
+ return $mapping[strtolower(trim($groupName))] ?? '';
+ }//end mapGroupNameToRollenEnum()
/**
* Gets the mapping of allowed roles to group names
@@ -574,22 +764,22 @@ private function assignUserGroups(\OCP\IUser $user, array $objectData, bool $isF
private function getAllowedRoleGroups(): array
{
return [
- 'Aanbod-beheerder' => 'Aanbod-beheerder',
- 'Gebruik-beheerder' => 'Gebruik-beheerder',
- 'Gebruik-raadpleger' => 'Gebruik-raadpleger',
+ 'Aanbod-beheerder' => 'Aanbod-beheerder',
+ 'Gebruik-beheerder' => 'Gebruik-beheerder',
+ 'Gebruik-raadpleger' => 'Gebruik-raadpleger',
'Functioneel-beheerder' => 'Functioneel-beheerder',
- 'VNG-raadpleger' => 'VNG-raadpleger',
+ 'VNG-raadpleger' => 'VNG-raadpleger',
'Organisatie-beheerder' => 'Organisatie-beheerder',
- 'Ambtenaar' => 'Ambtenaar'
+ 'Ambtenaar' => 'Ambtenaar',
];
- }
+ }//end getAllowedRoleGroups()
/**
* Adds a user to a group, creating the group if it doesn't exist
*
- * @param \OCP\IUser $user The user to add
- * @param string $groupName The group name
- * @param string $type The type of group assignment (for logging)
+ * @param \OCP\IUser $user The user to add
+ * @param string $groupName The group name
+ * @param string $type The type of group assignment (for logging)
*
* @return void
*/
@@ -597,9 +787,9 @@ private function addUserToGroup(\OCP\IUser $user, string $groupName, string $typ
{
try {
$group = $this->_groupManager->get($groupName);
- if (!$group) {
+ if ($group === null) {
$group = $this->_groupManager->createGroup($groupName);
- if ($group) {
+ if (empty($group) === false) {
$this->_logger->info(
'Created group for user assignment',
['groupName' => $groupName, 'type' => $type]
@@ -607,36 +797,36 @@ private function addUserToGroup(\OCP\IUser $user, string $groupName, string $typ
}
}
- if ($group && !$group->inGroup($user)) {
+ if ($group !== false && $group->inGroup($user) === false) {
$group->addUser($user);
$this->_logger->info(
'Added user to group',
[
- 'username' => $user->getUID(),
+ 'username' => $user->getUID(),
'groupName' => $groupName,
- 'type' => $type
+ 'type' => $type,
]
);
}
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to add user to group: ' . $e->getMessage(),
+ 'Failed to add user to group: '.$e->getMessage(),
[
- 'username' => $user->getUID(),
+ 'username' => $user->getUID(),
'groupName' => $groupName,
- 'type' => $type,
- 'exception' => $e
+ 'type' => $type,
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end addUserToGroup()
/**
* Adds a user to a group only if the group exists, does not create new groups
*
- * @param \OCP\IUser $user The user to add to the group
- * @param string $groupName The name of the group
- * @param string $type The type of group assignment for logging
+ * @param \OCP\IUser $user The user to add to the group
+ * @param string $groupName The name of the group
+ * @param string $type The type of group assignment for logging
*
* @return void
*/
@@ -644,58 +834,58 @@ private function addUserToGroupWithCheck(\OCP\IUser $user, string $groupName, st
{
try {
$group = $this->_groupManager->get($groupName);
-
- if (!$group) {
+
+ if ($group === null) {
$this->_logger->warning(
'Group does not exist, skipping user assignment',
[
- 'username' => $user->getUID(),
+ 'username' => $user->getUID(),
'groupName' => $groupName,
- 'type' => $type
+ 'type' => $type,
]
);
return;
}
- if (!$group->inGroup($user)) {
+ if ($group->inGroup($user) === false) {
$group->addUser($user);
$this->_logger->info(
'Added user to existing group',
[
- 'username' => $user->getUID(),
+ 'username' => $user->getUID(),
'groupName' => $groupName,
- 'type' => $type
+ 'type' => $type,
]
);
} else {
$this->_logger->debug(
'User already in group',
[
- 'username' => $user->getUID(),
+ 'username' => $user->getUID(),
'groupName' => $groupName,
- 'type' => $type
+ 'type' => $type,
]
);
}
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to add user to group with check: ' . $e->getMessage(),
+ 'Failed to add user to group with check: '.$e->getMessage(),
[
- 'username' => $user->getUID(),
+ 'username' => $user->getUID(),
'groupName' => $groupName,
- 'type' => $type,
- 'exception' => $e
+ 'type' => $type,
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end addUserToGroupWithCheck()
/**
* Updates user groups when contact person data changes
* Note: Role assignment is now based on organization type, not individual roles
*
- * @param \OCP\IUser $user The user to update
- * @param array $contactData The updated contact person data
+ * @param \OCP\IUser $user The user to update
+ * @param array $contactData The updated contact person data
*
* @return void
*/
@@ -703,8 +893,8 @@ public function updateUserGroupsFromContactData(\OCP\IUser $user, array $contact
{
try {
$organizationId = $contactData['organisation'] ?? $contactData['organisatie'] ?? '';
-
- if (empty($organizationId)) {
+
+ if (empty($organizationId) === true) {
$this->_logger->warning(
'No organization ID found for user group update',
['username' => $user->getUID()]
@@ -712,92 +902,91 @@ public function updateUserGroupsFromContactData(\OCP\IUser $user, array $contact
return;
}
- // Get organization type and determine role group
- $organizationType = $this->getOrganizationType((string)$organizationId);
- $newRoleGroup = $this->getRoleGroupByOrganizationType($organizationType);
-
- if (empty($newRoleGroup)) {
+ // Get organization type and determine role group.
+ $organizationType = $this->getOrganizationType(organizationId: (string) $organizationId);
+ $newRoleGroup = $this->getRoleGroupByOrganizationType(organizationType: $organizationType);
+
+ if (empty($newRoleGroup) === true) {
$this->_logger->warning(
'No role group mapping found for organization type during update',
[
- 'username' => $user->getUID(),
- 'organizationId' => $organizationId,
- 'organizationType' => $organizationType
+ 'username' => $user->getUID(),
+ 'organizationId' => $organizationId,
+ 'organizationType' => $organizationType,
]
);
return;
}
- // Remove user from old organization type role groups
+ // Remove user from old organization type role groups.
$allPossibleRoleGroups = ['gebruik-beheerder', 'aanbod-beheerder'];
foreach ($allPossibleRoleGroups as $roleGroup) {
if ($roleGroup !== $newRoleGroup) {
$group = $this->_groupManager->get($roleGroup);
- if ($group && $group->inGroup($user)) {
+ if ($group !== false && $group->inGroup($user) === true) {
$group->removeUser($user);
$this->_logger->info(
'Removed user from old organization type role group',
[
- 'username' => $user->getUID(),
+ 'username' => $user->getUID(),
'groupName' => $roleGroup,
- 'reason' => 'organization type changed'
+ 'reason' => 'organization type changed',
]
);
}
}
}
- // Add user to new role group if it exists
- $this->addUserToGroupWithCheck($user, $newRoleGroup, 'organization-type-role-update');
+ // Add user to new role group if it exists.
+ $this->addUserToGroupWithCheck(user: $user, groupName: $newRoleGroup, type: 'organization-type-role-update');
$this->_logger->info(
'Updated user groups based on organization type',
[
- 'username' => $user->getUID(),
- 'organizationId' => $organizationId,
+ 'username' => $user->getUID(),
+ 'organizationId' => $organizationId,
'organizationType' => $organizationType,
- 'assignedRole' => $newRoleGroup
+ 'assignedRole' => $newRoleGroup,
]
);
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to update user groups from contact data: ' . $e->getMessage(),
+ 'Failed to update user groups from contact data: '.$e->getMessage(),
[
- 'username' => $user->getUID(),
- 'exception' => $e
+ 'username' => $user->getUID(),
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end updateUserGroupsFromContactData()
/**
* Legacy method for backward compatibility - now redirects to organization type-based logic
*
- * @param \OCP\IUser $user The user to update
- * @param array $newRoles The new roles (ignored - kept for compatibility)
- * @param array $oldRoles The old roles (ignored - kept for compatibility)
+ * @param \OCP\IUser $user The user to update
+ * @param array $newRoles The new roles (ignored - kept for compatibility)
+ * @param array $oldRoles The old roles (ignored - kept for compatibility)
*
- * @return void
+ * @return void
* @deprecated Use updateUserGroupsFromContactData instead
*/
- public function updateUserGroupsFromRoles(\OCP\IUser $user, array $newRoles, array $oldRoles = []): void
+ public function updateUserGroupsFromRoles(\OCP\IUser $user, array $newRoles, array $oldRoles=[]): void
{
$this->_logger->info(
'updateUserGroupsFromRoles is deprecated - role assignment now based on organization type',
[
'username' => $user->getUID(),
'newRoles' => $newRoles,
- 'oldRoles' => $oldRoles
+ 'oldRoles' => $oldRoles,
]
);
-
- // For backward compatibility, try to find the user's contact data and update based on organization type
+
+ // For backward compatibility, try to find the user's contact data and update based on organization type.
try {
- $contactObject = $this->findContactpersoonByUsername($user->getUID());
- if ($contactObject) {
+ $contactObject = $this->findContactpersoonByUsername(username: $user->getUID());
+ if (empty($contactObject) === false) {
$contactData = $contactObject->getObject();
- $this->updateUserGroupsFromContactData($user, $contactData);
+ $this->updateUserGroupsFromContactData(user: $user, contactData: $contactData);
} else {
$this->_logger->warning(
'Could not find contact person data for user - cannot update groups',
@@ -806,16 +995,14 @@ public function updateUserGroupsFromRoles(\OCP\IUser $user, array $newRoles, arr
}
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to update user groups via legacy method: ' . $e->getMessage(),
+ 'Failed to update user groups via legacy method: '.$e->getMessage(),
[
- 'username' => $user->getUID(),
- 'exception' => $e
+ 'username' => $user->getUID(),
+ 'exception' => $e,
]
);
}
- }
-
-
+ }//end updateUserGroupsFromRoles()
/**
* Finds contactpersoon object by username
@@ -827,41 +1014,41 @@ public function updateUserGroupsFromRoles(\OCP\IUser $user, array $newRoles, arr
private function findContactpersoonByUsername(string $username): ?object
{
try {
- $objectService = $this->_getObjectService();
+ $objectService = $this->getObjectService();
$settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
- // Get configuration values
+ // Get configuration values.
$registerId = $settingsService->getVoorzieningenRegisterId();
$contactpersoonSchemaId = $settingsService->getSchemaIdForObjectType('contactpersoon');
- if (!$registerId || !$contactpersoonSchemaId) {
+ if ($registerId === null || $contactpersoonSchemaId === false) {
throw new \Exception('Register or schema ID not configured for contactpersoon');
}
- // Search for contactpersoon with the given username
+ // Search for contactpersoon with the given username.
$searchFilters = [
- 'username' => $username
+ 'username' => $username,
];
$results = $objectService->findAll($searchFilters, $registerId, $contactpersoonSchemaId);
- if (!empty($results)) {
- return $results[0]; // Return the first match
+ if (empty($results) === false) {
+ return $results[0];
+ // Return the first match.
}
return null;
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to find contactpersoon by username: ' . $e->getMessage(),
+ 'Failed to find contactpersoon by username: '.$e->getMessage(),
[
- 'username' => $username,
- 'exception' => $e
+ 'username' => $username,
+ 'exception' => $e,
]
);
return null;
- }
- }
+ }//end try
+ }//end findContactpersoonByUsername()
/**
* Gets the organization group for a given organization ID
@@ -873,71 +1060,73 @@ private function findContactpersoonByUsername(string $username): ?object
private function getOrganizationGroup(string $organizationId): ?\OCP\IGroup
{
try {
- // Get the organization object to find its group
- $objectService = $this->_getObjectService();
- if (!$objectService) {
+ // Get the organization object to find its group.
+ $objectService = $this->getObjectService();
+ if ($objectService === null) {
return null;
}
- // Get register and schema IDs dynamically from configuration
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
- $registerId = $settingsService->getVoorzieningenRegisterId();
+ // Get register and schema IDs dynamically from configuration.
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+ $registerId = $settingsService->getVoorzieningenRegisterId();
$organisatieSchemaId = $settingsService->getSchemaIdForObjectType('organisatie');
- if (!$registerId || !$organisatieSchemaId) {
+ if ($registerId === null || $organisatieSchemaId === false) {
$this->_logger->warning('Register or schema ID not configured for organisatie');
return null;
}
- // Use find() method with proper register/schema context
+ // Use find() method with proper register/schema context.
$organizationObject = $objectService->find($organizationId, [], false, $registerId, $organisatieSchemaId);
- if ($organizationObject) {
+ if (empty($organizationObject) === false) {
$organizationData = $organizationObject->getObject();
- $groupId = $organizationData['group'] ?? '';
+ $groupId = $organizationData['group'] ?? '';
- if (!empty($groupId)) {
+ if (empty($groupId) === false) {
$group = $this->_groupManager->get($groupId);
return $group;
}
}
return null;
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to get organization group: ' . $e->getMessage(),
+ 'Failed to get organization group: '.$e->getMessage(),
[
'organizationId' => $organizationId,
- 'exception' => $e
+ 'exception' => $e,
]
);
return null;
- }
- }
+ }//end try
+ }//end getOrganizationGroup()
/**
* Determines if this contact object is the first contact for the organization
*
* @param object $contactObject The contact object being processed (contactpersoon)
- * @param array $objectData The contact data
+ * @param array $objectData The contact data
*
* @return bool True if this is the first contact for the organization
*/
public function isFirstContactForOrganization(object $contactObject, array $objectData): bool
{
- // Simplified approach: Default to true so the first contact always gets admin rights
- // A more sophisticated check can be implemented later if needed to track
- // whether other contacts already exist for this organization
- $this->_logger->info('isFirstContactForOrganization: Defaulting to true (simplified)', [
- 'app' => 'softwarecatalog',
- 'contactId' => $contactObject->getId(),
- 'contactUuid' => $contactObject->getUuid()
- ]);
+ // Simplified approach: Default to true so the first contact always gets admin rights.
+ // A more sophisticated check can be implemented later if needed to track.
+ // whether other contacts already exist for this organization.
+ $this->_logger->info(
+ 'isFirstContactForOrganization: Defaulting to true (simplified)',
+ [
+ 'app' => 'softwarecatalog',
+ 'contactId' => $contactObject->getId(),
+ 'contactUuid' => $contactObject->getUuid(),
+ ]
+ );
return true;
- }
+ }//end isFirstContactForOrganization()
/**
* Stores organization UUID in user config for OpenConnector access
@@ -947,7 +1136,7 @@ public function isFirstContactForOrganization(object $contactObject, array $obje
* It also sets the user's active organisation in OpenRegister so they're
* automatically logged into the correct organisation.
*
- * @param IUser $user The user object
+ * @param IUser $user The user object
* @param string|int $organizationUuid The organization UUID (can be string or int)
*
* @return void
@@ -955,11 +1144,11 @@ public function isFirstContactForOrganization(object $contactObject, array $obje
private function storeUserOrganizationUuid(IUser $user, string|int $organizationUuid): void
{
try {
- if (!empty($organizationUuid)) {
- // Convert to string to ensure consistent storage
- $organizationUuidStr = (string)$organizationUuid;
+ if (empty($organizationUuid) === false) {
+ // Convert to string to ensure consistent storage.
+ $organizationUuidStr = (string) $organizationUuid;
- // Store in core config for OpenConnector access
+ // Store in core config for OpenConnector access.
$this->config->setUserValue(
$user->getUID(),
'core',
@@ -967,7 +1156,7 @@ private function storeUserOrganizationUuid(IUser $user, string|int $organization
$organizationUuidStr
);
- // Also set as active organisation in OpenRegister
+ // Also set as active organisation in OpenRegister.
try {
$this->config->setUserValue(
$user->getUID(),
@@ -979,34 +1168,34 @@ private function storeUserOrganizationUuid(IUser $user, string|int $organization
$this->_logger->info(
'Stored organization UUID in user config and set as active organisation',
[
- 'username' => $user->getUID(),
- 'organizationUuid' => $organizationUuidStr,
- 'organizationUuid_type' => gettype($organizationUuid)
+ 'username' => $user->getUID(),
+ 'organizationUuid' => $organizationUuidStr,
+ 'organizationUuid_type' => gettype($organizationUuid),
]
);
} catch (\Exception $e) {
$this->_logger->warning(
'Failed to set active organisation in OpenRegister config, but core config was successful',
[
- 'username' => $user->getUID(),
+ 'username' => $user->getUID(),
'organizationUuid' => $organizationUuidStr,
- 'error' => $e->getMessage()
+ 'error' => $e->getMessage(),
]
);
- }
- }
+ }//end try
+ }//end if
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to store organization UUID in user config: ' . $e->getMessage(),
+ 'Failed to store organization UUID in user config: '.$e->getMessage(),
[
- 'username' => $user->getUID(),
- 'organizationUuid' => $organizationUuid,
+ 'username' => $user->getUID(),
+ 'organizationUuid' => $organizationUuid,
'organizationUuid_type' => gettype($organizationUuid),
- 'exception' => $e
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end storeUserOrganizationUuid()
/**
* Gets a display name from contact data
@@ -1017,14 +1206,21 @@ private function storeUserOrganizationUuid(IUser $user, string|int $organization
*/
private function getDisplayNameFromContactData(array $contactData): string
{
- $parts = array_filter([
- $contactData['voornaam'] ?? '',
- $contactData['tussenvoegsel'] ?? '',
- $contactData['achternaam'] ?? ''
- ]);
+ $parts = array_filter(
+ [
+ $contactData['voornaam'] ?? '',
+ $contactData['tussenvoegsel'] ?? '',
+ $contactData['achternaam'] ?? '',
+ ]
+ );
- return implode(' ', $parts) ?: ($contactData['email'] ?? $contactData['e-mailadres'] ?? 'Unknown User');
- }
+ $fullName = implode(' ', $parts);
+ if (empty($fullName) === false) {
+ return $fullName;
+ } else {
+ return ($contactData['email'] ?? $contactData['e-mailadres'] ?? 'Unknown User');
+ }
+ }//end getDisplayNameFromContactData()
/**
* Stores contact person name fields in Nextcloud user config
@@ -1043,39 +1239,39 @@ public function storeContactNameFields(\OCP\IUser $user, array $contactData): vo
try {
$userId = $user->getUID();
- // Store name fields in Nextcloud user config (core app)
- // These are read by OpenRegister UserService::getCustomNameFields()
- $firstName = $contactData['voornaam'] ?? '';
+ // Store name fields in Nextcloud user config (core app).
+ // These are read by OpenRegister UserService::getCustomNameFields().
+ $firstName = $contactData['voornaam'] ?? '';
$middleName = $contactData['tussenvoegsel'] ?? '';
- $lastName = $contactData['achternaam'] ?? '';
- $functie = $contactData['functie'] ?? '';
+ $lastName = $contactData['achternaam'] ?? '';
+ $functie = $contactData['functie'] ?? '';
- if (!empty($firstName)) {
+ if (empty($firstName) === false) {
$this->config->setUserValue($userId, 'core', 'firstName', $firstName);
}
- if (!empty($lastName)) {
+ if (empty($lastName) === false) {
$this->config->setUserValue($userId, 'core', 'lastName', $lastName);
}
- if (!empty($middleName)) {
+ if (empty($middleName) === false) {
$this->config->setUserValue($userId, 'core', 'middleName', $middleName);
}
- // Store functie in AccountManager as 'role' property
- // This is read by OpenRegister UserService via AccountManager
- if (!empty($functie)) {
+ // Store functie in AccountManager as 'role' property.
+ // This is read by OpenRegister UserService via AccountManager.
+ if (empty($functie) === false) {
try {
$accountManager = $this->_container->get('OCP\Accounts\IAccountManager');
- $account = $accountManager->getAccount($user);
+ $account = $accountManager->getAccount($user);
- // Try to set the role property
+ // Try to set the role property.
$roleProperty = $account->getProperty(\OCP\Accounts\IAccountManager::PROPERTY_ROLE);
if ($roleProperty !== null) {
$roleProperty->setValue($functie);
$accountManager->updateAccount($account);
} else {
- // Property doesn't exist, create it
+ // Property doesn't exist, create it.
$account->setProperty(
\OCP\Accounts\IAccountManager::PROPERTY_ROLE,
$functie,
@@ -1085,41 +1281,52 @@ public function storeContactNameFields(\OCP\IUser $user, array $contactData): vo
$accountManager->updateAccount($account);
}
} catch (\Exception $e) {
- // Fallback: store functie in user config if AccountManager fails
+ // Fallback: store functie in user config if AccountManager fails.
$this->config->setUserValue($userId, 'core', 'functie', $functie);
- $this->_logger->warning('Failed to store functie in AccountManager, stored in user config', [
- 'userId' => $userId,
- 'functie' => $functie,
- 'error' => $e->getMessage()
- ]);
- }
- }
+ $this->_logger->warning(
+ 'Failed to store functie in AccountManager, stored in user config',
+ [
+ 'userId' => $userId,
+ 'functie' => $functie,
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+ }//end if
// Sync e-mailadres to user's email property.
$email = $contactData['e-mailadres'] ?? $contactData['email'] ?? '';
- if (!empty($email) && $email !== $user->getEMailAddress()) {
+ if (empty($email) === false && $email !== $user->getEMailAddress()) {
$user->setEMailAddress($email);
- $this->_logger->info('Updated user email from contactpersoon', [
- 'userId' => $userId,
- 'email' => $email
- ]);
+ $this->_logger->info(
+ 'Updated user email from contactpersoon',
+ [
+ 'userId' => $userId,
+ 'email' => $email,
+ ]
+ );
}
- $this->_logger->info('Stored contact name fields in user config', [
- 'userId' => $userId,
- 'firstName' => $firstName,
- 'middleName' => $middleName,
- 'lastName' => $lastName,
- 'functie' => $functie
- ]);
-
+ $this->_logger->info(
+ 'Stored contact name fields in user config',
+ [
+ 'userId' => $userId,
+ 'firstName' => $firstName,
+ 'middleName' => $middleName,
+ 'lastName' => $lastName,
+ 'functie' => $functie,
+ ]
+ );
} catch (\Exception $e) {
- $this->_logger->error('Failed to store contact name fields', [
- 'userId' => $user->getUID(),
- 'error' => $e->getMessage()
- ]);
- }
- }
+ $this->_logger->error(
+ 'Failed to store contact name fields',
+ [
+ 'userId' => $user->getUID(),
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+ }//end storeContactNameFields()
/**
* Handles new contact creation
@@ -1131,23 +1338,25 @@ public function storeContactNameFields(\OCP\IUser $user, array $contactData): vo
public function handleNewContact(object $contactObject): void
{
try {
- $this->_logger->info('Handling new contact', [
- 'objectId' => $contactObject->getId()
- ]);
-
- // Process the contact to ensure proper user structure
- $this->processContactpersoon($contactObject);
+ $this->_logger->info(
+ 'Handling new contact',
+ [
+ 'objectId' => $contactObject->getId(),
+ ]
+ );
+ // Process the contact to ensure proper user structure.
+ $this->processContactpersoon(contactpersoonObject: $contactObject);
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to handle new contact: ' . $e->getMessage(),
+ 'Failed to handle new contact: '.$e->getMessage(),
[
- 'objectId' => $contactObject->getId(),
- 'exception' => $e
+ 'objectId' => $contactObject->getId(),
+ 'exception' => $e,
]
);
}
- }
+ }//end handleNewContact()
/**
* Handles contact update
@@ -1159,23 +1368,25 @@ public function handleNewContact(object $contactObject): void
public function handleContactUpdate(object $contactObject): void
{
try {
- $this->_logger->info('Handling contact update', [
- 'objectId' => $contactObject->getId()
- ]);
-
- // Process the updated contact
- $this->processContactpersoon($contactObject);
+ $this->_logger->info(
+ 'Handling contact update',
+ [
+ 'objectId' => $contactObject->getId(),
+ ]
+ );
+ // Process the updated contact.
+ $this->processContactpersoon(contactpersoonObject: $contactObject);
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to handle contact update: ' . $e->getMessage(),
+ 'Failed to handle contact update: '.$e->getMessage(),
[
- 'objectId' => $contactObject->getId(),
- 'exception' => $e
+ 'objectId' => $contactObject->getId(),
+ 'exception' => $e,
]
);
}
- }
+ }//end handleContactUpdate()
/**
* Handles contact deletion
@@ -1187,92 +1398,96 @@ public function handleContactUpdate(object $contactObject): void
public function handleContactDeletion(object $contactObject): void
{
try {
- $this->_logger->info('Handling contact deletion', [
- 'objectId' => $contactObject->getId()
- ]);
+ $this->_logger->info(
+ 'Handling contact deletion',
+ [
+ 'objectId' => $contactObject->getId(),
+ ]
+ );
- // Get the contact data before deletion
+ // Get the contact data before deletion.
$objectData = $contactObject->getObject();
- $username = $objectData['username'] ?? '';
+ $username = $objectData['username'] ?? '';
- if (!empty($username)) {
+ if (empty($username) === false) {
$user = $this->_userManager->get($username);
- if ($user) {
- // Option 1: Delete the user account
- // $user->delete();
-
- // Option 2: Just disable the user
+ if (empty($user) === false) {
+ // Option 1: Delete the user account.
+ // $user->delete();.
+ // Option 2: Just disable the user.
$user->setEnabled(false);
$this->_logger->info(
'User account disabled due to contact deletion',
[
- 'username' => $username,
- 'contactId' => $contactObject->getId()
+ 'username' => $username,
+ 'contactId' => $contactObject->getId(),
]
);
- // Send account suspension notification email
- $this->sendAccountSuspensionEmail($user, $objectData);
+ // Send account suspension notification email.
+ $this->sendAccountSuspensionEmail(user: $user, objectData: $objectData);
}
- }
-
+ }//end if
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to handle contact deletion: ' . $e->getMessage(),
+ 'Failed to handle contact deletion: '.$e->getMessage(),
[
- 'objectId' => $contactObject->getId(),
- 'exception' => $e
+ 'objectId' => $contactObject->getId(),
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end handleContactDeletion()
/**
* Assigns beheerder role to a user
*
* @param object $contactpersoonObject The contactpersoon object
- * @param string $username The username
- * @param string $organizationUuid The organization UUID
+ * @param string $username The username
+ * @param string $organizationUuid The organization UUID
*
* @return void
*/
public function assignBeheerderRole(object $contactpersoonObject, string $username, string $organizationUuid): void
{
try {
- $objectData = $contactpersoonObject->getObject();
+ $objectData = $contactpersoonObject->getObject();
$currentRoles = $objectData['roles'] ?? [];
- if (!is_array($currentRoles)) {
+ if (is_array($currentRoles) === false) {
$currentRoles = [];
}
- // Add beheerder role if not already present
- if (!in_array('beheerder', array_map('strtolower', $currentRoles))) {
+ // Add beheerder role if not already present.
+ if (in_array('beheerder', array_map('strtolower', $currentRoles)) === false) {
$currentRoles[] = 'beheerder';
- // Update the contactpersoon object (but don't save to prevent event loops)
+ // Update the contactpersoon object (but don't save to prevent event loops).
$objectData['roles'] = $currentRoles;
$contactpersoonObject->setObject($objectData);
- // Note: NOT saving the object here to prevent infinite event loops
- // The original API call/operation will handle persistence
- $this->_logger->info('Beheerder role added to contactpersoon object, but not saved to prevent event loops', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid,
- 'updatedRoles' => $currentRoles,
- 'objectId' => $contactpersoonObject->getId()
- ]);
+ // Note: NOT saving the object here to prevent infinite event loops.
+ // The original API call/operation will handle persistence.
+ $this->_logger->info(
+ 'Beheerder role added to contactpersoon object, but not saved to prevent event loops',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ 'updatedRoles' => $currentRoles,
+ 'objectId' => $contactpersoonObject->getId(),
+ ]
+ );
- // Add user to beheerder group
+ // Add user to beheerder group.
$beheerderGroup = $this->_groupManager->get('beheerder');
- if (!$beheerderGroup) {
+ if ($beheerderGroup === null) {
$beheerderGroup = $this->_groupManager->createGroup('beheerder');
}
- if ($beheerderGroup) {
+ if (empty($beheerderGroup) === false) {
$user = $this->_userManager->get($username);
- if ($user && !$beheerderGroup->inGroup($user)) {
+ if ($user !== false && $beheerderGroup->inGroup($user) === false) {
$beheerderGroup->addUser($user);
}
}
@@ -1280,29 +1495,28 @@ public function assignBeheerderRole(object $contactpersoonObject, string $userna
$this->_logger->info(
'Assigned beheerder role to first user in organization',
[
- 'username' => $username,
+ 'username' => $username,
'organization' => $organizationUuid,
- 'newRoles' => $currentRoles
+ 'newRoles' => $currentRoles,
]
);
- }
-
+ }//end if
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to assign beheerder role: ' . $e->getMessage(),
+ 'Failed to assign beheerder role: '.$e->getMessage(),
[
- 'username' => $username,
+ 'username' => $username,
'organization' => $organizationUuid,
- 'exception' => $e
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end assignBeheerderRole()
/**
* Sets a user's manager in Nextcloud
*
- * @param string $username The username
+ * @param string $username The username
* @param string $managerUsername The manager's username
*
* @return void
@@ -1310,24 +1524,24 @@ public function assignBeheerderRole(object $contactpersoonObject, string $userna
public function setUserManager(string $username, string $managerUsername): void
{
try {
- $user = $this->_userManager->get($username);
+ $user = $this->_userManager->get($username);
$manager = $this->_userManager->get($managerUsername);
- if (!$user || !$manager) {
+ if ($user === null || $manager === false) {
$this->_logger->warning(
'Cannot set manager - user or manager not found',
[
- 'username' => $username,
- 'manager' => $managerUsername,
- 'userExists' => $user !== null,
- 'managerExists' => $manager !== null
+ 'username' => $username,
+ 'manager' => $managerUsername,
+ 'userExists' => $user !== null,
+ 'managerExists' => $manager !== null,
]
);
return;
}
- // In Nextcloud, we can set this as a user preference or custom attribute
- // Since there's no built-in manager field, we'll use preferences
+ // In Nextcloud, we can set this as a user preference or custom attribute.
+ // Since there's no built-in manager field, we'll use preferences.
\OC::$server->getConfig()->setUserValue(
$username,
'softwarecatalog',
@@ -1339,21 +1553,20 @@ public function setUserManager(string $username, string $managerUsername): void
'Set user manager',
[
'username' => $username,
- 'manager' => $managerUsername
+ 'manager' => $managerUsername,
]
);
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to set user manager: ' . $e->getMessage(),
+ 'Failed to set user manager: '.$e->getMessage(),
[
- 'username' => $username,
- 'manager' => $managerUsername,
- 'exception' => $e
+ 'username' => $username,
+ 'manager' => $managerUsername,
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end setUserManager()
/**
* Gets a user's manager
@@ -1372,19 +1585,22 @@ public function getUserManager(string $username): ?string
''
);
- return !empty($manager) ? $manager : null;
-
+ if (empty($manager) === false) {
+ return $manager;
+ } else {
+ return null;
+ }
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to get user manager: ' . $e->getMessage(),
+ 'Failed to get user manager: '.$e->getMessage(),
[
- 'username' => $username,
- 'exception' => $e
+ 'username' => $username,
+ 'exception' => $e,
]
);
return null;
- }
- }
+ }//end try
+ }//end getUserManager()
/**
* Gets the organization type for a given organization ID
@@ -1396,20 +1612,23 @@ public function getUserManager(string $username): ?string
private function getOrganizationType(string $organizationId): string
{
try {
- // Get the organization object to find its type
- $objectService = $this->_getObjectService();
+ // Get the organization object to find its type.
+ $objectService = $this->getObjectService();
- $this->_logger->info('Getting organization type', [
- 'organizationId' => $organizationId
- ]);
+ $this->_logger->info(
+ 'Getting organization type',
+ [
+ 'organizationId' => $organizationId,
+ ]
+ );
- // Get voorzieningen config for register and schema
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+ // Get voorzieningen config for register and schema.
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
$voorzieningenConfig = $settingsService->getVoorzieningenConfig();
- $register = $voorzieningenConfig['register'] ?? '';
- $organizationSchema = $voorzieningenConfig['organisatie_schema'] ?? '';
+ $register = $voorzieningenConfig['register'] ?? '';
+ $organizationSchema = $voorzieningenConfig['organisatie_schema'] ?? '';
- // Find by UUID - use find() with register and schema
+ // Find by UUID - use find() with register and schema.
$organizationObject = $objectService->find(
id: $organizationId,
register: $register,
@@ -1418,37 +1637,43 @@ private function getOrganizationType(string $organizationId): string
_multitenancy: false
);
- if ($organizationObject) {
+ if (empty($organizationObject) === false) {
$organizationData = $organizationObject->getObject();
$organizationType = $organizationData['type'] ?? '';
-
- $this->_logger->info('Found organization type', [
- 'organizationId' => $organizationId,
- 'type' => $organizationType,
- 'normalizedType' => strtolower($organizationType)
- ]);
-
- return $organizationType; // Don't convert to lowercase here, let getRoleGroupByOrganizationType handle it
+
+ $this->_logger->info(
+ 'Found organization type',
+ [
+ 'organizationId' => $organizationId,
+ 'type' => $organizationType,
+ 'normalizedType' => strtolower($organizationType),
+ ]
+ );
+
+ return $organizationType;
+ // Don't convert to lowercase here, let getRoleGroupByOrganizationType handle it.
}
- $this->_logger->warning('Organization not found', [
- 'organizationId' => $organizationId
- ]);
+ $this->_logger->warning(
+ 'Organization not found',
+ [
+ 'organizationId' => $organizationId,
+ ]
+ );
return '';
-
} catch (\Exception $e) {
- $this->_logger->error(
- 'Failed to get organization type: ' . $e->getMessage(),
+ // "Object not found" is expected for NC org UUIDs that don't have a matching.
+ // register organisatie object (e.g. orgs created outside the sync process).
+ // Log at warning level — the caller handles '' gracefully.
+ $this->_logger->warning(
+ 'Could not determine organization type (org may not be synced yet): '.$e->getMessage(),
[
'organizationId' => $organizationId,
- 'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine()
]
);
return '';
- }
- }
+ }//end try
+ }//end getOrganizationType()
/**
* Maps organization type to role group based on business rules
@@ -1459,29 +1684,29 @@ private function getOrganizationType(string $organizationId): string
*/
private function getRoleGroupByOrganizationType(string $organizationType): string
{
- // Normalize the organization type to lowercase for comparison
+ // Normalize the organization type to lowercase for comparison.
$normalizedType = strtolower(trim($organizationType));
-
- // Define the mapping based on requirements:
- // "Gemeente" -> "gebruik-beheerder"
- // "Leverancier" -> "aanbod-beheerder"
- // "Samenwerking" -> "gebruik-beheerder"
- // "Community" -> "aanbod-beheerder"
+
+ // Define the mapping based on requirements:.
+ // "Gemeente" -> "gebruik-beheerder".
+ // "Leverancier" -> "aanbod-beheerder".
+ // "Samenwerking" -> "gebruik-beheerder".
+ // "Community" -> "aanbod-beheerder".
$typeToRoleMapping = [
- 'gemeente' => 'gebruik-beheerder',
- 'leverancier' => 'aanbod-beheerder',
+ 'gemeente' => 'gebruik-beheerder',
+ 'leverancier' => 'aanbod-beheerder',
'samenwerking' => 'gebruik-beheerder',
- 'community' => 'aanbod-beheerder'
+ 'community' => 'aanbod-beheerder',
];
return $typeToRoleMapping[$normalizedType] ?? '';
- }
+ }//end getRoleGroupByOrganizationType()
/**
* Sends user creation email
*
- * @param \OCP\IUser $user The created user
- * @param array $objectData The contact person data
+ * @param \OCP\IUser $user The created user
+ * @param array $objectData The contact person data
*
* @return void
*/
@@ -1489,76 +1714,93 @@ private function sendUserCreationEmail(\OCP\IUser $user, array $objectData): voi
{
try {
- $this->_logger->info('Sending user creation email', [
- 'username' => $user->getUID(),
- 'email' => $user->getEMailAddress()
- ]);
+ $this->_logger->info(
+ 'Sending user creation email',
+ [
+ 'username' => $user->getUID(),
+ 'email' => $user->getEMailAddress(),
+ ]
+ );
- // Prepare user data for email
+ // Prepare user data for email.
$userData = [
- 'username' => $user->getUID(),
- 'email' => $user->getEMailAddress(),
+ 'username' => $user->getUID(),
+ 'email' => $user->getEMailAddress(),
'displayName' => $user->getDisplayName(),
- 'voornaam' => $objectData['voornaam'] ?? '',
- 'achternaam' => $objectData['achternaam'] ?? '',
- 'roles' => $objectData['roles'] ?? []
+ 'voornaam' => $objectData['voornaam'] ?? '',
+ 'achternaam' => $objectData['achternaam'] ?? '',
+ 'roles' => $objectData['roles'] ?? [],
];
- // Get organization data if available
+ // Get organization data if available.
$organizationData = [];
- $organizationId = $objectData['organisation'] ?? $objectData['organisatie'] ?? '';
- if (!empty($organizationId)) {
+ $organizationId = $objectData['organisation'] ?? $objectData['organisatie'] ?? '';
+ if (empty($organizationId) === false) {
try {
- $objectService = $this->_getObjectService();
- // Get register and schema IDs dynamically from configuration
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
- $registerId = $settingsService->getVoorzieningenRegisterId();
+ $objectService = $this->getObjectService();
+ // Get register and schema IDs dynamically from configuration.
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+ $registerId = $settingsService->getVoorzieningenRegisterId();
$organisatieSchemaId = $settingsService->getSchemaIdForObjectType('organisatie');
- if (!$registerId || !$organisatieSchemaId) {
+ if ($registerId === null || $organisatieSchemaId === false) {
$this->_logger->warning('Register or schema ID not configured for organisatie');
return;
}
$organizationObject = $objectService->find($organizationId, [], false, $registerId, $organisatieSchemaId);
- if ($organizationObject) {
+ if (empty($organizationObject) === false) {
$organizationData = $organizationObject->getObject();
- $this->_logger->info('Retrieved organization data for email', [
- 'organizationId' => $organizationId,
- 'organizationUuid' => $organizationData['id'] ?? 'NOT_SET',
- 'organizationName' => $organizationData['naam'] ?? 'NOT_SET'
- ]);
+ $this->_logger->info(
+ 'Retrieved organization data for email',
+ [
+ 'organizationId' => $organizationId,
+ 'organizationUuid' => $organizationData['id'] ?? 'NOT_SET',
+ 'organizationName' => $organizationData['naam'] ?? 'NOT_SET',
+ ]
+ );
}
} catch (\Exception $e) {
- $this->_logger->warning('Failed to get organization data for email: ' . $e->getMessage(), [
- 'organizationId' => $organizationId
- ]);
- }
- }
+ $this->_logger->warning(
+ 'Failed to get organization data for email: '.$e->getMessage(),
+ [
+ 'organizationId' => $organizationId,
+ ]
+ );
+ }//end try
+ }//end if
- // Send user creation email
+ // Send user creation email.
$success = $this->_emailService->sendUserCreationEmail($userData, $organizationData);
- if ($success) {
- $this->_logger->info('User creation email sent successfully', [
- 'username' => $user->getUID(),
- 'email' => $user->getEMailAddress()
- ]);
+ if (empty($success) === false) {
+ $this->_logger->info(
+ 'User creation email sent successfully',
+ [
+ 'username' => $user->getUID(),
+ 'email' => $user->getEMailAddress(),
+ ]
+ );
} else {
- $this->_logger->warning('Failed to send user creation email', [
- 'username' => $user->getUID(),
- 'email' => $user->getEMailAddress()
- ]);
+ $this->_logger->warning(
+ 'Failed to send user creation email',
+ [
+ 'username' => $user->getUID(),
+ 'email' => $user->getEMailAddress(),
+ ]
+ );
}
-
} catch (\Exception $e) {
- $this->_logger->error('Exception sending user creation email: ' . $e->getMessage(), [
- 'username' => $user->getUID(),
- 'email' => $user->getEMailAddress(),
- 'exception' => $e
- ]);
- }
- }
+ $this->_logger->error(
+ 'Exception sending user creation email: '.$e->getMessage(),
+ [
+ 'username' => $user->getUID(),
+ 'email' => $user->getEMailAddress(),
+ 'exception' => $e,
+ ]
+ );
+ }//end try
+ }//end sendUserCreationEmail()
/**
* Processes a contactpersoon object to create an inactive user
@@ -1567,123 +1809,138 @@ private function sendUserCreationEmail(\OCP\IUser $user, array $objectData): voi
* this method will create an inactive user account and set the username property.
*
* @param object $contactpersoonObject The contactpersoon object to process
- * @param bool $isUpdate Whether this is an update operation (defaults to false)
+ * @param bool $isUpdate Whether this is an update operation (defaults to false)
*
* @return bool True if processing was successful
* @throws \Exception If processing fails
*/
- public function processContactpersoon(object $contactpersoonObject, bool $isUpdate = false): bool
+ public function processContactpersoon(object $contactpersoonObject, bool $isUpdate=false): bool
{
try {
- $this->_logger->info('Processing contactpersoon object', [
- 'objectId' => $contactpersoonObject->getId(),
- 'isUpdate' => $isUpdate
- ]);
+ $this->_logger->info(
+ 'Processing contactpersoon object',
+ [
+ 'objectId' => $contactpersoonObject->getId(),
+ 'isUpdate' => $isUpdate,
+ ]
+ );
- // Get object data
+ // Get object data.
$objectData = $contactpersoonObject->getObject();
- // Check if username exists and is filled
+ // Check if username exists and is filled.
$username = $objectData['username'] ?? '';
- if (empty($username)) {
+ if (empty($username) === true) {
$this->_logger->info('Username not found or empty, creating inactive user account');
- // Generate username from name fields
- $username = $this->generateUsernameFromContactData($objectData);
+ // Generate username from name fields.
+ $username = $this->generateUsernameFromContactData(contactData: $objectData);
- // For updates, try to find existing user first to avoid expensive isFirstContactForOrganization check
- if ($isUpdate) {
+ // For updates, try to find existing user first to avoid expensive isFirstContactForOrganization check.
+ if (empty($isUpdate) === false) {
$existingUser = $this->_userManager->get($username);
- if ($existingUser) {
- $this->_logger->info('Found existing user during update, skipping expensive first contact check', [
- 'username' => $username,
- 'objectId' => $contactpersoonObject->getId()
- ]);
-
- // Update the contactpersoon object with the username (but don't save to prevent event loops)
+ if (empty($existingUser) === false) {
+ $this->_logger->info(
+ 'Found existing user during update, skipping expensive first contact check',
+ [
+ 'username' => $username,
+ 'objectId' => $contactpersoonObject->getId(),
+ ]
+ );
+
+ // Update the contactpersoon object with the username (but don't save to prevent event loops).
$objectData['username'] = $username;
$contactpersoonObject->setObject($objectData);
- $this->_logger->info('Username added to contactpersoon object during update, but not saved to prevent event loops', [
- 'username' => $username,
- 'objectId' => $contactpersoonObject->getId()
- ]);
+ $this->_logger->info(
+ 'Username added to contactpersoon object during update, but not saved to prevent event loops',
+ [
+ 'username' => $username,
+ 'objectId' => $contactpersoonObject->getId(),
+ ]
+ );
- // Ensure contactpersoon is added to organization
- $this->ensureContactpersoonInOrganization($contactpersoonObject);
+ // Ensure contactpersoon is added to organization.
+ $this->ensureContactpersoonInOrganization(contactpersoonObject: $contactpersoonObject);
return true;
- }
- }
+ }//end if
+ }//end if
- // Determine if this is the first contact for the organization (expensive operation)
- $isFirstContact = $this->isFirstContactForOrganization($contactpersoonObject, $objectData);
+ // Determine if this is the first contact for the organization (expensive operation).
+ $isFirstContact = $this->isFirstContactForOrganization(contactObject: $contactpersoonObject, objectData: $objectData);
- // Create the user account
- $user = $this->createUserAccount($contactpersoonObject, $isFirstContact);
+ // Create the user account.
+ $user = $this->createUserAccount(contactpersoonObject: $contactpersoonObject, isFirstContact: $isFirstContact);
if ($user === null) {
throw new \Exception('Failed to create user account');
}
- // Set user to inactive initially
- $this->setUserInactive($user->getUID());
+ // Set user to inactive initially.
+ $this->setUserInactive(username: $user->getUID());
- // Update the contactpersoon object with the username (but don't save to prevent event loops)
+ // Update the contactpersoon object with the username (but don't save to prevent event loops).
$objectData['username'] = $username;
$contactpersoonObject->setObject($objectData);
- // Note: NOT saving the object here to prevent infinite event loops
- // The original API call/operation will handle persistence
- $this->_logger->info('Username added to contactpersoon object, but not saved to prevent event loops', [
- 'username' => $username,
- 'objectId' => $contactpersoonObject->getId()
- ]);
+ // Note: NOT saving the object here to prevent infinite event loops.
+ // The original API call/operation will handle persistence.
+ $this->_logger->info(
+ 'Username added to contactpersoon object, but not saved to prevent event loops',
+ [
+ 'username' => $username,
+ 'objectId' => $contactpersoonObject->getId(),
+ ]
+ );
- // Ensure contactpersoon is added to organization
- $this->ensureContactpersoonInOrganization($contactpersoonObject);
+ // Ensure contactpersoon is added to organization.
+ $this->ensureContactpersoonInOrganization(contactpersoonObject: $contactpersoonObject);
- // Also add user to organization entity (OpenRegister entity, not object)
+ // Also add user to organization entity (OpenRegister entity, not object).
$organizationUuid = $objectData['organisation'] ?? $objectData['organisatie'] ?? '';
- $this->addUserToOrganizationEntity($contactpersoonObject, $username, $organizationUuid);
+ $this->addUserToOrganizationEntity(
+ contactpersoonObject: $contactpersoonObject,
+ username: $username,
+ organizationUuidOverride: $organizationUuid
+ );
$this->_logger->info(
'Successfully created inactive user and updated contactpersoon',
[
'username' => $username,
- 'objectId' => $contactpersoonObject->getId()
+ 'objectId' => $contactpersoonObject->getId(),
]
);
return true;
- }
+ }//end if
$this->_logger->info(
'Username already exists, contactpersoon processed',
[
'username' => $username,
- 'objectId' => $contactpersoonObject->getId()
+ 'objectId' => $contactpersoonObject->getId(),
]
);
- // Ensure contactpersoon is added to organization (even for existing users)
- $this->ensureContactpersoonInOrganization($contactpersoonObject);
+ // Ensure contactpersoon is added to organization (even for existing users).
+ $this->ensureContactpersoonInOrganization(contactpersoonObject: $contactpersoonObject);
return true;
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to process contactpersoon object: ' . $e->getMessage(),
+ 'Failed to process contactpersoon object: '.$e->getMessage(),
[
'exception' => $e,
- 'objectId' => $contactpersoonObject->getId() ?? 'unknown'
+ 'objectId' => $contactpersoonObject->getId() ?? 'unknown',
]
);
throw $e;
- }
- }
+ }//end try
+ }//end processContactpersoon()
/**
* Sets a user account to inactive
@@ -1697,13 +1954,13 @@ public function setUserInactive(string $username): bool
try {
$user = $this->_userManager->get($username);
- if ($user) {
+ if (empty($user) === false) {
$user->setEnabled(false);
$this->_logger->info(
'Set user account to inactive',
[
- 'username' => $username
+ 'username' => $username,
]
);
@@ -1712,25 +1969,24 @@ public function setUserInactive(string $username): bool
$this->_logger->warning(
'User not found when trying to set inactive',
[
- 'username' => $username
+ 'username' => $username,
]
);
return false;
- }
-
+ }//end if
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to set user inactive: ' . $e->getMessage(),
+ 'Failed to set user inactive: '.$e->getMessage(),
[
- 'username' => $username,
- 'exception' => $e
+ 'username' => $username,
+ 'exception' => $e,
]
);
return false;
- }
- }
+ }//end try
+ }//end setUserInactive()
/**
* Sets a user account to active
@@ -1744,13 +2000,13 @@ public function setUserActive(string $username): bool
try {
$user = $this->_userManager->get($username);
- if ($user) {
+ if (empty($user) === false) {
$user->setEnabled(true);
$this->_logger->info(
'Set user account to active',
[
- 'username' => $username
+ 'username' => $username,
]
);
@@ -1759,30 +2015,29 @@ public function setUserActive(string $username): bool
$this->_logger->warning(
'User not found when trying to set active',
[
- 'username' => $username
+ 'username' => $username,
]
);
return false;
- }
-
+ }//end if
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to set user active: ' . $e->getMessage(),
+ 'Failed to set user active: '.$e->getMessage(),
[
- 'username' => $username,
- 'exception' => $e
+ 'username' => $username,
+ 'exception' => $e,
]
);
return false;
- }
- }
+ }//end try
+ }//end setUserActive()
/**
* Handles contactpersoon updates, particularly role changes
*
- * @param object $contactpersoonObject The updated contactpersoon object
+ * @param object $contactpersoonObject The updated contactpersoon object
* @param object $oldContactpersoonObject The previous contactpersoon object
*
* @return void
@@ -1790,100 +2045,110 @@ public function setUserActive(string $username): bool
public function handleContactpersoonUpdate(object $contactpersoonObject, object $oldContactpersoonObject): void
{
try {
- $this->_logger->info('Handling contactpersoon update', [
- 'objectId' => $contactpersoonObject->getId()
- ]);
+ $this->_logger->info(
+ 'Handling contactpersoon update',
+ [
+ 'objectId' => $contactpersoonObject->getId(),
+ ]
+ );
- // Process the updated contactpersoon
- $this->processContactpersoon($contactpersoonObject);
+ // Process the updated contactpersoon.
+ $this->processContactpersoon(contactpersoonObject: $contactpersoonObject);
- // Check for role changes and update groups accordingly
+ // Check for role changes and update groups accordingly.
$newData = $contactpersoonObject->getObject();
$oldData = $oldContactpersoonObject->getObject();
$newRoles = $newData['roles'] ?? [];
$oldRoles = $oldData['roles'] ?? [];
- // Ensure both are arrays
- if (!is_array($newRoles)) {
+ // Ensure both are arrays.
+ if (is_array($newRoles) === false) {
$newRoles = [$newRoles];
}
- if (!is_array($oldRoles)) {
+
+ if (is_array($oldRoles) === false) {
$oldRoles = [$oldRoles];
}
- // Check if roles or organization have changed (organization type determines role assignment)
+ // Check if roles or organization have changed (organization type determines role assignment).
$oldOrganization = $oldData['organisation'] ?? $oldData['organisatie'] ?? '';
$newOrganization = $newData['organisation'] ?? $newData['organisatie'] ?? '';
-
+
if ($newRoles !== $oldRoles || $oldOrganization !== $newOrganization) {
$username = $newData['username'] ?? '';
- if (!empty($username)) {
+ if (empty($username) === false) {
$user = $this->_userManager->get($username);
- if ($user) {
+ if (empty($user) === false) {
$this->_logger->info(
'Contact person data changed, updating user groups based on organization type',
[
'contactpersoonId' => $contactpersoonObject->getId(),
- 'username' => $username,
- 'oldRoles' => $oldRoles,
- 'newRoles' => $newRoles,
- 'oldOrganization' => $oldOrganization,
- 'newOrganization' => $newOrganization
+ 'username' => $username,
+ 'oldRoles' => $oldRoles,
+ 'newRoles' => $newRoles,
+ 'oldOrganization' => $oldOrganization,
+ 'newOrganization' => $newOrganization,
]
);
- // Update user groups based on organization type (roles are now ignored)
- $this->updateUserGroupsFromContactData($user, $newData);
+ // Update user groups based on organization type (roles are now ignored).
+ $this->updateUserGroupsFromContactData(user: $user, contactData: $newData);
}
}
- }
-
+ }//end if
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to handle contactpersoon update: ' . $e->getMessage(),
+ 'Failed to handle contactpersoon update: '.$e->getMessage(),
[
- 'objectId' => $contactpersoonObject->getId(),
- 'exception' => $e
+ 'objectId' => $contactpersoonObject->getId(),
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end handleContactpersoonUpdate()
/**
* Sends account suspension notification email
*
- * @param \OCP\IUser $user The suspended user
- * @param array $objectData The contact person data
+ * @param \OCP\IUser $user The suspended user
+ * @param array $objectData The contact person data
*
* @return void
*/
private function sendAccountSuspensionEmail(\OCP\IUser $user, array $objectData): void
{
try {
- $this->_logger->info('Sending account suspension email', [
- 'username' => $user->getUID(),
- 'email' => $user->getEMailAddress()
- ]);
-
- // For now, we'll use a simple log message as the PhpEmailService
- // doesn't have a specific suspension email method yet
- // This can be extended later if needed
-
- $this->_logger->info('Account suspension email would be sent here', [
- 'username' => $user->getUID(),
- 'email' => $user->getEMailAddress(),
- 'displayName' => $user->getDisplayName()
- ]);
+ $this->_logger->info(
+ 'Sending account suspension email',
+ [
+ 'username' => $user->getUID(),
+ 'email' => $user->getEMailAddress(),
+ ]
+ );
+ // For now, we'll use a simple log message as the PhpEmailService.
+ // doesn't have a specific suspension email method yet.
+ // This can be extended later if needed.
+ $this->_logger->info(
+ 'Account suspension email would be sent here',
+ [
+ 'username' => $user->getUID(),
+ 'email' => $user->getEMailAddress(),
+ 'displayName' => $user->getDisplayName(),
+ ]
+ );
} catch (\Exception $e) {
- $this->_logger->error('Exception sending account suspension email: ' . $e->getMessage(), [
- 'username' => $user->getUID(),
- 'email' => $user->getEMailAddress(),
- 'exception' => $e
- ]);
- }
- }
+ $this->_logger->error(
+ 'Exception sending account suspension email: '.$e->getMessage(),
+ [
+ 'username' => $user->getUID(),
+ 'email' => $user->getEMailAddress(),
+ 'exception' => $e,
+ ]
+ );
+ }//end try
+ }//end sendAccountSuspensionEmail()
/**
* Checks if a contactpersoon username is in the organization's users list
@@ -1895,66 +2160,70 @@ private function sendAccountSuspensionEmail(\OCP\IUser $user, array $objectData)
public function shouldAddContactpersoonToOrganization(object $contactpersoonObject): bool
{
try {
- $objectData = $contactpersoonObject->getObject();
- $username = $objectData['username'] ?? '';
+ $objectData = $contactpersoonObject->getObject();
+ $username = $objectData['username'] ?? '';
$organizationUuid = $objectData['organisation'] ?? '';
- if (empty($username) || empty($organizationUuid)) {
+ if (empty($username) === true || empty($organizationUuid) === true) {
return false;
}
- $objectService = $this->_getObjectService();
- if (!$objectService) {
+ $objectService = $this->getObjectService();
+ if ($objectService === null) {
return false;
}
- // Get the organization object
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
- $registerId = $settingsService->getVoorzieningenRegisterId();
+ // Get the organization object.
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+ $registerId = $settingsService->getVoorzieningenRegisterId();
$organisatieSchemaId = $settingsService->getSchemaIdForObjectType('organisatie');
- if (!$registerId || !$organisatieSchemaId) {
+ if ($registerId === null || $organisatieSchemaId === false) {
return false;
}
try {
$organizationObject = $objectService->find($organizationUuid, [], false, $registerId, $organisatieSchemaId);
- $organizationData = $organizationObject->getObject();
+ $organizationData = $organizationObject->getObject();
- // Check if the username is already in the organization's users
+ // Check if the username is already in the organization's users.
$organizationUsers = $organizationData['users'] ?? [];
- if (is_array($organizationUsers) && !in_array($username, $organizationUsers)) {
- $this->_logger->info('ContactPersonHandler: Contactpersoon should be added to organization', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid,
- 'currentUsers' => $organizationUsers
- ]);
+ if (is_array($organizationUsers) === true && in_array($username, $organizationUsers) === false) {
+ $this->_logger->info(
+ 'ContactPersonHandler: Contactpersoon should be added to organization',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ 'currentUsers' => $organizationUsers,
+ ]
+ );
return true;
}
return false;
-
} catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
- // Organization doesn't exist, so we can't add the user
- $this->_logger->warning('ContactPersonHandler: Organization not found for contactpersoon', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
+ // Organization doesn't exist, so we can't add the user.
+ $this->_logger->warning(
+ 'ContactPersonHandler: Organization not found for contactpersoon',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return false;
- }
-
+ }//end try
} catch (\Exception $e) {
$this->_logger->error(
- 'ContactPersonHandler: Failed to check if contactpersoon should be added to organization: ' . $e->getMessage(),
+ 'ContactPersonHandler: Failed to check if contactpersoon should be added to organization: '.$e->getMessage(),
[
- 'objectId' => $contactpersoonObject->getId(),
- 'exception' => $e->getMessage()
+ 'objectId' => $contactpersoonObject->getId(),
+ 'exception' => $e->getMessage(),
]
);
return false;
- }
- }
+ }//end try
+ }//end shouldAddContactpersoonToOrganization()
/**
* Adds a contactpersoon username to the organization's users list
@@ -1966,49 +2235,52 @@ public function shouldAddContactpersoonToOrganization(object $contactpersoonObje
public function addContactpersoonToOrganization(object $contactpersoonObject): bool
{
try {
- $objectData = $contactpersoonObject->getObject();
- $username = $objectData['username'] ?? '';
+ $objectData = $contactpersoonObject->getObject();
+ $username = $objectData['username'] ?? '';
$organizationUuid = $objectData['organisation'] ?? '';
- if (empty($username) || empty($organizationUuid)) {
- $this->_logger->warning('ContactPersonHandler: Cannot add contactpersoon to organization - missing username or organization', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
+ if (empty($username) === true || empty($organizationUuid) === true) {
+ $this->_logger->warning(
+ 'ContactPersonHandler: Cannot add contactpersoon to organization - missing username or organization',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return false;
}
- $objectService = $this->_getObjectService();
- if (!$objectService) {
+ $objectService = $this->getObjectService();
+ if ($objectService === null) {
$this->_logger->error('ContactPersonHandler: OpenRegister ObjectService not available');
return false;
}
- // Get the organization object
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
- $registerId = $settingsService->getVoorzieningenRegisterId();
+ // Get the organization object.
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+ $registerId = $settingsService->getVoorzieningenRegisterId();
$organisatieSchemaId = $settingsService->getSchemaIdForObjectType('organisatie');
- if (!$registerId || !$organisatieSchemaId) {
+ if ($registerId === null || $organisatieSchemaId === false) {
$this->_logger->error('ContactPersonHandler: Register or schema not configured for organisatie');
return false;
}
try {
$organizationObject = $objectService->find($organizationUuid, [], false, $registerId, $organisatieSchemaId);
- $organizationData = $organizationObject->getObject();
+ $organizationData = $organizationObject->getObject();
- // Add the username to the organization's users list
+ // Add the username to the organization's users list.
$organizationUsers = $organizationData['users'] ?? [];
- if (!is_array($organizationUsers)) {
+ if (is_array($organizationUsers) === false) {
$organizationUsers = [];
}
- if (!in_array($username, $organizationUsers)) {
- $organizationUsers[] = $username;
+ if (in_array($username, $organizationUsers) === false) {
+ $organizationUsers[] = $username;
$organizationData['users'] = $organizationUsers;
- // Update the organization object
+ // Update the organization object.
$updatedOrganization = $objectService->saveObject(
$organizationData,
[],
@@ -2017,43 +2289,51 @@ public function addContactpersoonToOrganization(object $contactpersoonObject): b
$organizationUuid
);
- $this->_logger->info('ContactPersonHandler: Successfully added contactpersoon to organization', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid,
- 'updatedUsers' => $organizationUsers
- ]);
+ $this->_logger->info(
+ 'ContactPersonHandler: Successfully added contactpersoon to organization',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ 'updatedUsers' => $organizationUsers,
+ ]
+ );
return true;
} else {
- $this->_logger->debug('ContactPersonHandler: Contactpersoon already in organization', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
- return true; // Already there, consider it successful
- }
-
+ $this->_logger->debug(
+ 'ContactPersonHandler: Contactpersoon already in organization',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+ return true;
+ // Already there, consider it successful.
+ }//end if
} catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
- $this->_logger->error('ContactPersonHandler: Organization not found for contactpersoon', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->error(
+ 'ContactPersonHandler: Organization not found for contactpersoon',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return false;
- }
-
+ }//end try
} catch (\Exception $e) {
$this->_logger->error(
- 'ContactPersonHandler: Failed to add contactpersoon to organization: ' . $e->getMessage(),
+ 'ContactPersonHandler: Failed to add contactpersoon to organization: '.$e->getMessage(),
[
- 'objectId' => $contactpersoonObject->getId(),
+ 'objectId' => $contactpersoonObject->getId(),
'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString()
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
]
);
return false;
- }
- }
+ }//end try
+ }//end addContactpersoonToOrganization()
/**
* Ensures contactpersoon is added to organization after user creation/update
@@ -2065,43 +2345,54 @@ public function addContactpersoonToOrganization(object $contactpersoonObject): b
public function ensureContactpersoonInOrganization(object $contactpersoonObject): void
{
try {
- $this->_logger->info('ContactPersonHandler: Ensuring contactpersoon is in organization', [
- 'objectId' => $contactpersoonObject->getId()
- ]);
-
- // Check if user should be added to organization
- if ($this->shouldAddContactpersoonToOrganization($contactpersoonObject)) {
- // Add user to organization
- $result = $this->addContactpersoonToOrganization($contactpersoonObject);
-
- if ($result) {
- $this->_logger->info('ContactPersonHandler: Successfully ensured contactpersoon in organization', [
- 'objectId' => $contactpersoonObject->getId()
- ]);
+ $this->_logger->info(
+ 'ContactPersonHandler: Ensuring contactpersoon is in organization',
+ [
+ 'objectId' => $contactpersoonObject->getId(),
+ ]
+ );
+
+ // Check if user should be added to organization.
+ if ($this->shouldAddContactpersoonToOrganization(contactpersoonObject: $contactpersoonObject) === true) {
+ // Add user to organization.
+ $result = $this->addContactpersoonToOrganization(contactpersoonObject: $contactpersoonObject);
+
+ if (empty($result) === false) {
+ $this->_logger->info(
+ 'ContactPersonHandler: Successfully ensured contactpersoon in organization',
+ [
+ 'objectId' => $contactpersoonObject->getId(),
+ ]
+ );
} else {
- $this->_logger->warning('ContactPersonHandler: Failed to add contactpersoon to organization', [
- 'objectId' => $contactpersoonObject->getId()
- ]);
+ $this->_logger->warning(
+ 'ContactPersonHandler: Failed to add contactpersoon to organization',
+ [
+ 'objectId' => $contactpersoonObject->getId(),
+ ]
+ );
}
} else {
- $this->_logger->debug('ContactPersonHandler: Contactpersoon already in organization or no action needed', [
- 'objectId' => $contactpersoonObject->getId()
- ]);
- }
-
+ $this->_logger->debug(
+ 'ContactPersonHandler: Contactpersoon already in organization or no action needed',
+ [
+ 'objectId' => $contactpersoonObject->getId(),
+ ]
+ );
+ }//end if
} catch (\Exception $e) {
$this->_logger->error(
- 'ContactPersonHandler: Failed to ensure contactpersoon in organization: ' . $e->getMessage(),
+ 'ContactPersonHandler: Failed to ensure contactpersoon in organization: '.$e->getMessage(),
[
- 'objectId' => $contactpersoonObject->getId(),
+ 'objectId' => $contactpersoonObject->getId(),
'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString()
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
]
);
- }
- }
+ }//end try
+ }//end ensureContactpersoonInOrganization()
/**
* Adds a user to the organization entity (OpenRegister entity, not object)
@@ -2110,98 +2401,128 @@ public function ensureContactpersoonInOrganization(object $contactpersoonObject)
* before adding the user to it. If the entity doesn't exist, it will be created
* from the organization object data.
*
- * @param object $contactpersoonObject The contactpersoon object
- * @param string $username The username to add
+ * @param object $contactpersoonObject The contactpersoon object
+ * @param string $username The username to add
* @param string|null $organizationUuidOverride Optional organization UUID to use instead of extracting from object
* (useful when organisatie field was removed from object data)
*
* @return void
*/
- public function addUserToOrganizationEntity(object $contactpersoonObject, string $username, ?string $organizationUuidOverride = null): void
- {
+ public function addUserToOrganizationEntity(
+ object $contactpersoonObject,
+ string $username,
+ ?string $organizationUuidOverride=null
+ ): void {
try {
$objectData = $contactpersoonObject->getObject();
- // Use override if provided (useful when organisatie field was removed from object)
+ // Use override if provided (useful when organisatie field was removed from object).
$organizationUuid = $organizationUuidOverride ?? $objectData['organisation'] ?? $objectData['organisatie'] ?? '';
- if (empty($organizationUuid)) {
- $this->_logger->warning('ContactPersonHandler: No organization reference found for contact person', [
- 'objectId' => $contactpersoonObject->getId(),
- 'username' => $username
- ]);
+ if (empty($organizationUuid) === true) {
+ $this->_logger->warning(
+ 'ContactPersonHandler: No organization reference found for contact person',
+ [
+ 'objectId' => $contactpersoonObject->getId(),
+ 'username' => $username,
+ ]
+ );
return;
}
- $this->_logger->info('ContactPersonHandler: Adding user to organization entity', [
- 'objectId' => $contactpersoonObject->getId(),
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->info(
+ 'ContactPersonHandler: Adding user to organization entity',
+ [
+ 'objectId' => $contactpersoonObject->getId(),
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
try {
$organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
-
- // Try to find the organisation entity
+
+ // Try to find the organisation entity.
try {
$organisation = $organisationMapper->findByUuid($organizationUuid);
-
- $this->_logger->info('ContactPersonHandler: Found existing organization entity', [
- 'organizationUuid' => $organizationUuid,
- 'organizationName' => $organisation->getName()
- ]);
+
+ $this->_logger->info(
+ 'ContactPersonHandler: Found existing organization entity',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'organizationName' => $organisation->getName(),
+ ]
+ );
} catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
- // Organization entity doesn't exist, create it from the object data
- $this->_logger->info('ContactPersonHandler: Organization entity not found, creating it', [
- 'organizationUuid' => $organizationUuid
- ]);
-
- $organisation = $this->ensureOrganizationEntity($organizationUuid);
-
- if (!$organisation) {
- $this->_logger->error('ContactPersonHandler: Failed to create organization entity', [
- 'organizationUuid' => $organizationUuid
- ]);
+ // Organization entity doesn't exist, create it from the object data.
+ $this->_logger->info(
+ 'ContactPersonHandler: Organization entity not found, creating it',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+
+ $organisation = $this->ensureOrganizationEntity(organizationUuid: $organizationUuid);
+
+ if ($organisation === null) {
+ $this->_logger->error(
+ 'ContactPersonHandler: Failed to create organization entity',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return;
}
- }
+ }//end try
- // Add user to the organisation entity
+ // Add user to the organisation entity.
$currentUsers = $organisation->getUsers() ?? [];
- if (!in_array($username, $currentUsers)) {
+ if (in_array($username, $currentUsers) === false) {
$currentUsers[] = $username;
$organisation->setUsers($currentUsers);
$organisationMapper->update($organisation);
- $this->_logger->info('ContactPersonHandler: Successfully added user to organization entity', [
- 'objectId' => $contactpersoonObject->getId(),
- 'username' => $username,
- 'organizationUuid' => $organizationUuid,
- 'totalUsers' => count($currentUsers)
- ]);
+ $this->_logger->info(
+ 'ContactPersonHandler: Successfully added user to organization entity',
+ [
+ 'objectId' => $contactpersoonObject->getId(),
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ 'totalUsers' => count($currentUsers),
+ ]
+ );
} else {
- $this->_logger->info('ContactPersonHandler: User already in organization entity', [
- 'objectId' => $contactpersoonObject->getId(),
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
- }
+ $this->_logger->info(
+ 'ContactPersonHandler: User already in organization entity',
+ [
+ 'objectId' => $contactpersoonObject->getId(),
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+ }//end if
} catch (\Exception $e) {
- $this->_logger->error('ContactPersonHandler: Failed to add user to organization entity', [
- 'objectId' => $contactpersoonObject->getId(),
- 'username' => $username,
- 'organizationUuid' => $organizationUuid,
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
- }
+ $this->_logger->error(
+ 'ContactPersonHandler: Failed to add user to organization entity',
+ [
+ 'objectId' => $contactpersoonObject->getId(),
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
+ }//end try
} catch (\Exception $e) {
- $this->_logger->error('ContactPersonHandler: Exception in addUserToOrganizationEntity', [
- 'objectId' => $contactpersoonObject->getId(),
- 'username' => $username,
- 'error' => $e->getMessage()
- ]);
- }
- }
+ $this->_logger->error(
+ 'ContactPersonHandler: Exception in addUserToOrganizationEntity',
+ [
+ 'objectId' => $contactpersoonObject->getId(),
+ 'username' => $username,
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+ }//end addUserToOrganizationEntity()
/**
* Ensures an organization entity exists in OpenRegister
@@ -2216,16 +2537,32 @@ public function addUserToOrganizationEntity(object $contactpersoonObject, string
private function ensureOrganizationEntity(string $organizationUuid): ?\OCA\OpenRegister\Db\Organisation
{
try {
- // Get the organization object from OpenRegister
- $objectService = $this->_getObjectService();
-
- // Get voorzieningen config for register and schema
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+ // First check if an entity with this UUID already exists (defensive double-check).
+ $organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
+ try {
+ $existing = $organisationMapper->findByUuid($organizationUuid);
+ $this->_logger->info(
+ 'ContactPersonHandler: Organization entity already exists (found by UUID)',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'organizationName' => $existing->getName(),
+ ]
+ );
+ return $existing;
+ } catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
+ // Expected — continue to create.
+ }
+
+ // Get the organization object from OpenRegister.
+ $objectService = $this->getObjectService();
+
+ // Get voorzieningen config for register and schema.
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
$voorzieningenConfig = $settingsService->getVoorzieningenConfig();
- $register = $voorzieningenConfig['register'] ?? '';
- $organizationSchema = $voorzieningenConfig['organisatie_schema'] ?? '';
-
- // Find the organization object by UUID - use find() with register and schema
+ $register = $voorzieningenConfig['register'] ?? '';
+ $organizationSchema = $voorzieningenConfig['organisatie_schema'] ?? '';
+
+ // Find the organization object by UUID - use find() with register and schema.
$organizationObject = $objectService->find(
id: $organizationUuid,
register: $register,
@@ -2233,54 +2570,86 @@ private function ensureOrganizationEntity(string $organizationUuid): ?\OCA\OpenR
_rbac: false,
_multitenancy: false
);
-
- if (!$organizationObject) {
- $this->_logger->error('ContactPersonHandler: Organization object not found in OpenRegister', [
- 'organizationUuid' => $organizationUuid
- ]);
+
+ if ($organizationObject === null) {
+ $this->_logger->error(
+ 'ContactPersonHandler: Organization object not found in OpenRegister',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return null;
}
-
+
$organizationData = $organizationObject->getObject();
-
- // Get organization name and description
- $organizationName = $organizationData['naam'] ?? $organizationData['name'] ?? 'Unknown Organization';
- $organizationDescription = $organizationData['beschrijving'] ?? $organizationData['beschrijvingLang'] ?? $organizationData['description'] ?? '';
-
- $this->_logger->info('ContactPersonHandler: Creating organization entity from object data', [
- 'organizationUuid' => $organizationUuid,
- 'organizationName' => $organizationName
- ]);
-
- // Create the organization entity using OrganisationService
+
+ // Get organization name and description.
+ // phpcs:ignore Generic.Files.LineLength.TooLong
+ $organizationName = $organizationData['naam'] ?? $organizationData['name'] ?? 'Unknown Organization';
+ $beschrijving = $organizationData['beschrijving'] ?? $organizationData['beschrijvingLang'] ?? null;
+ $organizationDescription = $beschrijving ?? $organizationData['description'] ?? '';
+
+ // Check if an entity with the same slug already exists (prevents unique constraint violation).
+ try {
+ $slug = strtolower(preg_replace('/[^a-z0-9]+/', '-', strtolower($organizationName)));
+ $slug = trim($slug, '-');
+ $existingBySlug = $organisationMapper->findBySlug($slug);
+ $this->_logger->info(
+ 'ContactPersonHandler: Organization entity already exists (found by slug)',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'slug' => $slug,
+ 'existingUuid' => $existingBySlug->getUuid(),
+ 'existingName' => $existingBySlug->getName(),
+ ]
+ );
+ return $existingBySlug;
+ } catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
+ // No existing entity by slug — proceed with creation.
+ }
+
+ $this->_logger->info(
+ 'ContactPersonHandler: Creating organization entity from object data',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'organizationName' => $organizationName,
+ ]
+ );
+
+ // Create the organization entity using OrganisationService.
$organisationService = $this->_container->get('OCA\\OpenRegister\\Service\\OrganisationService');
-
- // Create organisation with specific UUID, without adding current user (as we're in admin context)
+
+ // Create organisation with specific UUID, without adding current user (as we're in admin context).
$organisation = $organisationService->createOrganisation(
name: $organizationName,
description: $organizationDescription,
- addCurrentUser: false, // Don't add current user (admin) to this organisation
+ addCurrentUser: false,
+ // Don't add current user (admin) to this organisation.
uuid: $organizationUuid
);
-
- $this->_logger->info('ContactPersonHandler: Successfully created organization entity', [
- 'organizationUuid' => $organizationUuid,
- 'organizationName' => $organizationName,
- 'organizationId' => $organisation->getId()
- ]);
-
+
+ $this->_logger->info(
+ 'ContactPersonHandler: Successfully created organization entity',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'organizationName' => $organizationName,
+ 'organizationId' => $organisation->getId(),
+ ]
+ );
+
return $organisation;
-
} catch (\Exception $e) {
- $this->_logger->error('ContactPersonHandler: Failed to ensure organization entity', [
- 'organizationUuid' => $organizationUuid,
- 'error' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->_logger->error(
+ 'ContactPersonHandler: Failed to ensure organization entity',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'error' => $e->getMessage(),
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
return null;
- }
- }
-
-}
+ }//end try
+ }//end ensureOrganizationEntity()
+}//end class
diff --git a/lib/Service/SoftwareCatalogue/GroupHandler.php b/lib/Service/SoftwareCatalogue/GroupHandler.php
index 3e51540f..b6a656fe 100644
--- a/lib/Service/SoftwareCatalogue/GroupHandler.php
+++ b/lib/Service/SoftwareCatalogue/GroupHandler.php
@@ -10,7 +10,7 @@
* @package OCA\SoftwareCatalog\Service\SoftwareCatalogue
* @author Conduction b.v.
* @license AGPL-3.0-or-later https://www.gnu.org/licenses/agpl-3.0.html
- * @version 1.0.0
+ * @version GIT:
* @link https://github.com/ConductionNL/SoftwareCatalog
*/
@@ -34,7 +34,7 @@
* @package OCA\SoftwareCatalog\Service\SoftwareCatalogue
* @author Conduction b.v.
* @license AGPL-3.0-or-later https://www.gnu.org/licenses/agpl-3.0.html
- * @version 1.0.0
+ * @version GIT:
* @link https://github.com/ConductionNL/SoftwareCatalog
*/
class GroupHandler
@@ -49,12 +49,12 @@ class GroupHandler
/**
* GroupHandler constructor
*
- * @param IGroupManager $_groupManager Group manager interface
- * @param IUserManager $_userManager User manager interface
- * @param IAppConfig $_appConfig App configuration interface
- * @param ContainerInterface $_container Container interface
- * @param IAppManager $_appManager App manager interface
- * @param LoggerInterface $_logger Logger interface
+ * @param IGroupManager $_groupManager Group manager interface
+ * @param IUserManager $_userManager User manager interface
+ * @param IAppConfig $_appConfig App configuration interface
+ * @param ContainerInterface $_container Container interface
+ * @param IAppManager $_appManager App manager interface
+ * @param LoggerInterface $_logger Logger interface
*/
public function __construct(
private readonly IGroupManager $_groupManager,
@@ -64,22 +64,23 @@ public function __construct(
private readonly IAppManager $_appManager,
private readonly LoggerInterface $_logger,
) {
- }
+ }//end __construct()
/**
* Gets the OpenRegister ObjectService if available
*
* @return \OCA\OpenRegister\Service\ObjectService|null ObjectService instance or null
+ *
* @throws \RuntimeException If service is not available
*/
- private function _getObjectService(): ?\OCA\OpenRegister\Service\ObjectService
+ private function getObjectService(): ?\OCA\OpenRegister\Service\ObjectService
{
- if (in_array('openregister', $this->_appManager->getInstalledApps())) {
+ if (in_array(needle: 'openregister', haystack: $this->_appManager->getInstalledApps()) === true) {
return $this->_container->get('OCA\OpenRegister\Service\ObjectService');
}
throw new \RuntimeException('OpenRegister service is not available.');
- }
+ }//end getObjectService()
/**
* Gets the list of generic user groups from configuration
@@ -89,38 +90,42 @@ private function _getObjectService(): ?\OCA\OpenRegister\Service\ObjectService
public function getGenericUserGroups(): array
{
$groupsJson = $this->_appConfig->getValueString(self::APP_NAME, 'generic_user_groups', '');
-
- if (empty($groupsJson)) {
- // Return only truly generic groups as default (not role-specific)
- // Role-specific groups are now assigned based on organization type
+
+ if (empty($groupsJson) === true) {
+ // Return only truly generic groups as default (not role-specific).
+ // Role-specific groups are now assigned based on organization type.
return [
'software-catalog-users'
];
}
$groups = json_decode($groupsJson, true);
- return is_array($groups) ? $groups : [];
- }
+ if (is_array($groups) === true) {
+ return $groups;
+ }
+
+ return [];
+ }//end getGenericUserGroups()
/**
* Sets the list of generic user groups in configuration
*
* @param array $groups Array of generic user groups
- *
+ *
* @return void
*/
public function setGenericUserGroups(array $groups): void
{
$groupsJson = json_encode($groups, JSON_THROW_ON_ERROR);
$this->_appConfig->setValueString(self::APP_NAME, 'generic_user_groups', $groupsJson);
-
+
$this->_logger->info(
'Updated generic user groups configuration',
[
- 'groups' => $groups
+ 'groups' => $groups,
]
);
- }
+ }//end setGenericUserGroups()
/**
* Ensures that all generic user groups exist in the system
@@ -129,13 +134,13 @@ public function setGenericUserGroups(array $groups): void
*/
public function ensureGenericUserGroupsExist(): array
{
- $genericGroups = $this->getGenericUserGroups();
+ $genericGroups = $genericGroups = $this->getGenericUserGroups();
$createdGroups = [];
-
+
foreach ($genericGroups as $groupName) {
- if (!$this->_groupManager->get($groupName)) {
+ if ($this->_groupManager->get($groupName) === null) {
$group = $this->_groupManager->createGroup($groupName);
- if ($group) {
+ if ($group !== null) {
$createdGroups[] = $groupName;
$this->_logger->info(
'Created generic user group',
@@ -144,8 +149,8 @@ public function ensureGenericUserGroupsExist(): array
}
}
}
-
- // Also ensure role-based groups exist
+
+ // Also ensure role-based groups exist.
$roleBasedGroups = [
'aanbod-beheerder',
'gebruik-beheerder',
@@ -153,14 +158,16 @@ public function ensureGenericUserGroupsExist(): array
'functioneel-beheerder',
'vng-raadpleger',
'organisatie-beheerder',
- 'organisaties-beheerder', // Plural form for organization contacts
- 'ambtenaar' // For users from Gemeente organizations
+ // Plural form for organization contacts.
+ 'organisaties-beheerder',
+ // For users from Gemeente organizations.
+ 'ambtenaar',
];
-
+
foreach ($roleBasedGroups as $groupName) {
- if (!$this->_groupManager->get($groupName)) {
+ if ($this->_groupManager->get($groupName) === null) {
$group = $this->_groupManager->createGroup($groupName);
- if ($group) {
+ if ($group !== null) {
$createdGroups[] = $groupName;
$this->_logger->info(
'Created role-based group',
@@ -169,284 +176,283 @@ public function ensureGenericUserGroupsExist(): array
}
}
}
-
+
return $createdGroups;
- }
+ }//end ensureGenericUserGroupsExist()
/**
* Creates a group if it doesn't exist
*
* @param string $groupName The group name to create
- *
+ *
* @return IGroup|null The created or existing group
*/
public function createGroupIfNotExists(string $groupName): ?IGroup
{
$group = $this->_groupManager->get($groupName);
-
- if (!$group) {
+
+ if ($group === null) {
try {
$group = $this->_groupManager->createGroup($groupName);
$this->_logger->info(
'Created new group',
[
- 'groupName' => $groupName
+ 'groupName' => $groupName,
]
);
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to create group: ' . $e->getMessage(),
+ 'Failed to create group: '.$e->getMessage(),
[
'groupName' => $groupName,
- 'exception' => $e
+ 'exception' => $e,
]
);
return null;
}
}
-
+
return $group;
- }
+ }//end createGroupIfNotExists()
/**
* Updates user groups based on contactpersoon data
*
* @param object $contactpersoonObject The contactpersoon object
- * @param string $username The username to update groups for
- *
+ * @param string $username The username to update groups for
+ *
* @return void
*/
public function updateUserGroups(object $contactpersoonObject, string $username): void
{
try {
$user = $this->_userManager->get($username);
- if (!$user) {
+ if ($user === null) {
$this->_logger->warning('User not found for group update', ['username' => $username]);
return;
}
$objectData = $contactpersoonObject->getObject();
-
- // Handle role-based groups
- $this->updateRoleBasedGroups($user, $objectData);
-
- // Handle organization groups
- $this->updateOrganizationGroups($user, $objectData);
-
- // Handle special gemeente groups
- $this->updateGemeenteGroups($user, $objectData);
-
+
+ // Handle role-based groups.
+ $this->updateRoleBasedGroups(user: $user, objectData: $objectData);
+
+ // Handle organization groups.
+ $this->updateOrganizationGroups(user: $user, objectData: $objectData);
+
+ // Handle special gemeente groups.
+ $this->updateGemeenteGroups(user: $user, objectData: $objectData);
+
$this->_logger->info(
'Updated user groups successfully',
[
'username' => $username,
- 'groups' => array_keys($this->_groupManager->getUserGroups($user))
+ 'groups' => array_keys($this->_groupManager->getUserGroups($user)),
]
);
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to update user groups: ' . $e->getMessage(),
+ 'Failed to update user groups: '.$e->getMessage(),
[
- 'username' => $username,
- 'exception' => $e
+ 'username' => $username,
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end updateUserGroups()
/**
* Updates role-based groups for a user
*
* @param IUser $user The user to update
* @param array $objectData The contactpersoon data
- *
+ *
* @return void
*/
public function updateRoleBasedGroups(IUser $user, array $objectData): void
{
$userRoles = $objectData['roles'] ?? [];
- if (!is_array($userRoles)) {
+ if (is_array($userRoles) === false) {
$userRoles = [];
}
$this->_logger->info(
'Updating role-based groups for user',
[
- 'username' => $user->getUID(),
- 'userRoles' => $userRoles
+ 'username' => $user->getUID(),
+ 'userRoles' => $userRoles,
]
);
- // Get the configured generic user groups
- $genericGroups = $this->getGenericUserGroups();
-
+ // Get the configured generic user groups.
+ $genericGroups = $genericGroups = $this->getGenericUserGroups();
+
foreach ($genericGroups as $groupName) {
- $group = $this->createGroupIfNotExists($groupName);
-
- if ($group) {
- $hasRole = in_array($groupName, $userRoles);
+ $group = $this->createGroupIfNotExists(groupName: $groupName);
+
+ if ($group !== null) {
+ $hasRole = in_array(needle: $groupName, haystack: $userRoles);
$inGroup = $group->inGroup($user);
-
- if ($hasRole && !$inGroup) {
- // Add user to group
+
+ if ($hasRole === true && $inGroup === false) {
+ // Add user to group.
$group->addUser($user);
$this->_logger->info(
'Added user to role-based group',
[
'username' => $user->getUID(),
- 'group' => $groupName,
- 'role' => $groupName
+ 'group' => $groupName,
+ 'role' => $groupName,
]
);
- } elseif (!$hasRole && $inGroup) {
- // Remove user from group (except for system groups)
- // Note: Removed 'ambtenaar' from protected groups since it's no longer automatically assigned
- if (!in_array($groupName, ['software-catalog-users'])) {
+ } else if ($hasRole === false && $inGroup === true) {
+ // Remove user from group (except for system groups).
+ // Note: Removed 'ambtenaar' from protected groups since it's no longer automatically assigned.
+ if (in_array(needle: $groupName, haystack: ['software-catalog-users']) === false) {
$group->removeUser($user);
$this->_logger->info(
'Removed user from role-based group',
[
'username' => $user->getUID(),
- 'group' => $groupName
+ 'group' => $groupName,
]
);
}
- }
- }
- }
- }
+ }//end if
+ }//end if
+ }//end foreach
+ }//end updateRoleBasedGroups()
/**
* Updates organization-based groups for a user
*
* @param IUser $user The user to update
* @param array $objectData The contactpersoon data
- *
+ *
* @return void
*/
public function updateOrganizationGroups(IUser $user, array $objectData): void
{
$organizationUuid = $objectData['organisation'] ?? $objectData['organization'] ?? '';
-
- if (!empty($organizationUuid)) {
+
+ if (empty($organizationUuid) === false) {
try {
- // Get organization object
- $objectService = $this->_getObjectService();
-
- // Get register and schema IDs dynamically from configuration
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
- $registerId = $settingsService->getVoorzieningenRegisterId();
+ // Get organization object.
+ $objectService = $objectService = $this->getObjectService();
+
+ // Get register and schema IDs dynamically from configuration.
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+ $registerId = $settingsService->getVoorzieningenRegisterId();
$organisatieSchemaId = $settingsService->getSchemaIdForObjectType('organisatie');
-
- if (!$registerId || !$organisatieSchemaId) {
- $this->_logger->warning('Register or schema ID not configured for organisatie');
+
+ if ($registerId === null || $organisatieSchemaId === null) {
+ $this->_logger->warning('Register or schema ID not configured for organisatie.');
return;
}
-
+
$organizationObject = $objectService->find($organizationUuid, [], false, $registerId, $organisatieSchemaId);
-
- if ($organizationObject) {
- $orgData = $organizationObject->getObject();
+
+ if ($organizationObject !== null) {
+ $orgData = $organizationObject->getObject();
$actualUuid = $orgData['id'] ?? $organizationUuid;
- $groupId = $orgData['group'] ?? '';
-
+ $groupId = $orgData['group'] ?? '';
+
$this->_logger->info(
'DEBUG: Organization group lookup for user',
[
- 'username' => $user->getUID(),
- 'inputOrganizationUuid' => $organizationUuid,
+ 'username' => $user->getUID(),
+ 'inputOrganizationUuid' => $organizationUuid,
'actualOrganizationUuid' => $actualUuid,
- 'groupId' => $groupId
+ 'groupId' => $groupId,
]
);
-
- if (!empty($groupId)) {
+
+ if (empty($groupId) === false) {
$group = $this->_groupManager->get($groupId);
-
- if ($group && !$group->inGroup($user)) {
+
+ if ($group !== null && $group->inGroup($user) === false) {
$group->addUser($user);
$this->_logger->info(
'Added user to organization group',
[
- 'username' => $user->getUID(),
- 'group' => $groupId,
- 'organizationUuid' => $actualUuid
+ 'username' => $user->getUID(),
+ 'group' => $groupId,
+ 'organizationUuid' => $actualUuid,
]
);
}
}
- }
+ }//end if
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to process organization group: ' . $e->getMessage(),
+ 'Failed to process organization group: '.$e->getMessage(),
[
- 'username' => $user->getUID(),
- 'organizationUuid' => $organizationUuid
+ 'username' => $user->getUID(),
+ 'organizationUuid' => $organizationUuid,
]
);
- }
- }
- }
+ }//end try
+ }//end if
+ }//end updateOrganizationGroups()
/**
* Updates gemeente-specific groups for a user
*
* @param IUser $user The user to update
* @param array $objectData The contactpersoon data
- *
+ *
* @return void
*/
public function updateGemeenteGroups(IUser $user, array $objectData): void
{
$organizationUuid = $objectData['organisation'] ?? $objectData['organization'] ?? '';
-
- if (!empty($organizationUuid)) {
+
+ if (empty($organizationUuid) === false) {
try {
- // Get organization object
- $objectService = $this->_getObjectService();
-
- // Get register and schema IDs dynamically from configuration
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
- $registerId = $settingsService->getVoorzieningenRegisterId();
+ // Get organization object.
+ $objectService = $objectService = $this->getObjectService();
+
+ // Get register and schema IDs dynamically from configuration.
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+ $registerId = $settingsService->getVoorzieningenRegisterId();
$organisatieSchemaId = $settingsService->getSchemaIdForObjectType('organisatie');
-
- if (!$registerId || !$organisatieSchemaId) {
- $this->_logger->warning('Register or schema ID not configured for organisatie');
+
+ if ($registerId === null || $organisatieSchemaId === null) {
+ $this->_logger->warning('Register or schema ID not configured for organisatie.');
return;
}
-
+
$organizationObject = $objectService->find($organizationUuid, [], false, $registerId, $organisatieSchemaId);
-
- if ($organizationObject) {
- $orgData = $organizationObject->getObject();
+
+ if ($organizationObject !== null) {
+ $orgData = $organizationObject->getObject();
$actualUuid = $orgData['id'] ?? $organizationUuid;
- $orgType = strtolower($orgData['type'] ?? $orgData['soort'] ?? '');
-
- // Note: Removed automatic assignment of 'ambtenaar' group for gemeente organizations
- // The 'ambtenaar' group can still be created if needed, but users are not automatically assigned
+ $orgType = strtolower($orgData['type'] ?? $orgData['soort'] ?? '');
+
+ // Note: Removed automatic assignment of 'ambtenaar' group for gemeente organizations.
+ // The 'ambtenaar' group can still be created if needed, but users are not automatically assigned.
if ($orgType === 'gemeente') {
$this->_logger->debug(
'User from gemeente organization (no automatic ambtenaar group assignment)',
[
- 'username' => $user->getUID(),
+ 'username' => $user->getUID(),
'organizationUuid' => $actualUuid,
- 'organizationType' => $orgType
+ 'organizationType' => $orgType,
]
);
}
}
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to process gemeente group: ' . $e->getMessage(),
+ 'Failed to process gemeente group: '.$e->getMessage(),
[
- 'username' => $user->getUID(),
- 'organizationUuid' => $organizationUuid
+ 'username' => $user->getUID(),
+ 'organizationUuid' => $organizationUuid,
]
);
- }
- }
- }
+ }//end try
+ }//end if
+ }//end updateGemeenteGroups()
/**
* Gets all available groups with their information
@@ -455,53 +461,53 @@ public function updateGemeenteGroups(IUser $user, array $objectData): void
*/
public function getAllGroups(): array
{
- $groups = $this->_groupManager->search('');
+ $groups = $this->_groupManager->search('');
$groupInfo = [];
-
+
foreach ($groups as $group) {
$groupInfo[] = [
- 'id' => $group->getGID(),
+ 'id' => $group->getGID(),
'displayName' => $group->getDisplayName(),
'memberCount' => count($group->getUsers()),
- 'isGeneric' => in_array($group->getGID(), $this->getGenericUserGroups())
+ 'isGeneric' => in_array(needle: $group->getGID(), haystack: $this->getGenericUserGroups()),
];
}
-
+
return $groupInfo;
- }
+ }//end getAllGroups()
/**
* Validates a list of group names
*
* @param array $groups Array of group names to validate
- *
+ *
* @return array Array with validation results
*/
public function validateGroups(array $groups): array
{
$results = [
- 'valid' => [],
+ 'valid' => [],
'invalid' => [],
- 'errors' => []
+ 'errors' => [],
];
-
+
foreach ($groups as $groupName) {
- if (empty($groupName) || !is_string($groupName)) {
+ if (empty($groupName) === true || is_string($groupName) === false) {
$results['invalid'][] = $groupName;
- $results['errors'][] = 'Group name cannot be empty';
+ $results['errors'][] = 'Group name cannot be empty';
continue;
}
-
- // Check for invalid characters
- if (preg_match('/[^a-zA-Z0-9._-]/', $groupName)) {
+
+ // Check for invalid characters.
+ if (preg_match('/[^a-zA-Z0-9._-]/', $groupName) === true) {
$results['invalid'][] = $groupName;
- $results['errors'][] = "Group name '{$groupName}' contains invalid characters";
+ $results['errors'][] = "Group name '{$groupName}' contains invalid characters";
continue;
}
-
+
$results['valid'][] = $groupName;
}
-
+
return $results;
- }
-}
\ No newline at end of file
+ }//end validateGroups()
+}//end class
diff --git a/lib/Service/SoftwareCatalogue/HierarchyHandler.php b/lib/Service/SoftwareCatalogue/HierarchyHandler.php
index 02937a3f..8079f861 100644
--- a/lib/Service/SoftwareCatalogue/HierarchyHandler.php
+++ b/lib/Service/SoftwareCatalogue/HierarchyHandler.php
@@ -10,7 +10,7 @@
* @package OCA\SoftwareCatalog\Service\SoftwareCatalogue
* @author Conduction b.v.
* @license AGPL-3.0-or-later https://www.gnu.org/licenses/agpl-3.0.html
- * @version 1.0.0
+ * @version GIT:
* @link https://github.com/ConductionNL/SoftwareCatalog
*/
@@ -29,7 +29,7 @@
* @package OCA\SoftwareCatalog\Service\SoftwareCatalogue
* @author Conduction b.v.
* @license AGPL-3.0-or-later https://www.gnu.org/licenses/agpl-3.0.html
- * @version 1.0.0
+ * @version GIT:
* @link https://github.com/ConductionNL/SoftwareCatalog
*/
class HierarchyHandler
@@ -37,277 +37,288 @@ class HierarchyHandler
/**
* HierarchyHandler constructor
*
- * @param OrganizationHandler $_organizationHandler Organization handler
- * @param ContactPersonHandler $_contactPersonHandler Contact person handler
- * @param LoggerInterface $_logger Logger interface
+ * @param OrganizationHandler $_organizationHandler Organization handler
+ * @param ContactPersonHandler $_contactPersonHandler Contact person handler
+ * @param LoggerInterface $_logger Logger interface
*/
public function __construct(
private readonly OrganizationHandler $_organizationHandler,
private readonly ContactPersonHandler $_contactPersonHandler,
private readonly LoggerInterface $_logger,
) {
- }
+ }//end __construct()
/**
* Ensures organization has at least one beheerder and manages user hierarchy
*
* @param object $contactgegevensObject The contactgegevens object
* @param string $username The username being processed
- *
+ *
* @return void
*/
public function ensureOrganizationBeheerder(object $contactgegevensObject, string $username): void
{
try {
- $objectData = $contactgegevensObject->getObject();
- $organizationUuid = (string)($objectData['organisation'] ?? $objectData['organization'] ?? '');
-
- if (empty($organizationUuid)) {
- $this->_logger->debug('No organization linked to contactgegevens');
+ $objectData = $contactgegevensObject->getObject();
+ $organizationUuid = (string) ($objectData['organisation'] ?? $objectData['organization'] ?? '');
+
+ if (empty($organizationUuid) === true) {
+ $this->_logger->debug('No organization linked to contactgegevens.');
return;
}
- // Get organization and check for existing beheerders
+ // Get organization and check for existing beheerders.
$organizationBeheerders = $this->_organizationHandler->getOrganizationBeheerders($organizationUuid);
-
- if (empty($organizationBeheerders)) {
- // No beheerders found - make this user the beheerder
- $this->_contactPersonHandler->assignBeheerderRole($contactgegevensObject, $username, $organizationUuid);
- $organizationBeheerders = [$username]; // Update our list
+
+ if (empty($organizationBeheerders) === true) {
+ // No beheerders found - make this user the beheerder.
+ $this->_contactPersonHandler->assignBeheerderRole(
+ contactpersoonObject: $contactgegevensObject,
+ username: $username,
+ organizationUuid: $organizationUuid
+ );
+ $organizationBeheerders = [$username];
+ // Update our list.
}
-
- // Set up manager relationships
- $this->setupManagerRelationships($username, $organizationBeheerders, $organizationUuid);
-
+
+ // Set up manager relationships.
+ $this->setupManagerRelationships(
+ username: $username,
+ organizationBeheerders: $organizationBeheerders,
+ organizationUuid: $organizationUuid
+ );
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to ensure organization beheerder: ' . $e->getMessage(),
+ 'Failed to ensure organization beheerder: '.$e->getMessage(),
[
- 'username' => $username,
- 'exception' => $e
+ 'username' => $username,
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end ensureOrganizationBeheerder()
/**
* Sets up manager relationships for users in an organization
*
- * @param string $username The current username being processed
- * @param array $organizationBeheerders Array of beheerder usernames
- * @param string $organizationUuid The organization UUID
- *
+ * @param string $username The current username being processed
+ * @param array $organizationBeheerders Array of beheerder usernames
+ * @param string $organizationUuid The organization UUID
+ *
* @return void
*/
- public function setupManagerRelationships(string $username, array $organizationBeheerders, string $organizationUuid): void
- {
+ public function setupManagerRelationships(
+ string $username,
+ array $organizationBeheerders,
+ string $organizationUuid
+ ): void {
try {
- if (empty($organizationBeheerders)) {
+ if (empty($organizationBeheerders) === true) {
return;
}
-
- // The oldest beheerder becomes the manager
+
+ // The oldest beheerder becomes the manager.
$primaryManager = $organizationBeheerders[0];
-
- // If current user is not a beheerder, set their manager
- if (!in_array($username, $organizationBeheerders)) {
- $this->_contactPersonHandler->setUserManager($username, $primaryManager);
+
+ // If current user is not a beheerder, set their manager.
+ if (in_array(needle: $username, haystack: $organizationBeheerders) === false) {
+ $this->_contactPersonHandler->setUserManager(username: $username, managerUsername: $primaryManager);
}
-
- // If there are multiple beheerders, set the primary as manager for others
+
+ // If there are multiple beheerders, set the primary as manager for others.
if (count($organizationBeheerders) > 1) {
foreach ($organizationBeheerders as $beheerder) {
if ($beheerder !== $primaryManager) {
- $this->_contactPersonHandler->setUserManager($beheerder, $primaryManager);
+ $this->_contactPersonHandler->setUserManager(username: $beheerder, managerUsername: $primaryManager);
}
}
}
-
+
$this->_logger->info(
'Set up manager relationships',
[
- 'organization' => $organizationUuid,
+ 'organization' => $organizationUuid,
'primaryManager' => $primaryManager,
- 'allBeheerders' => $organizationBeheerders,
- 'processedUser' => $username
+ 'allBeheerders' => $organizationBeheerders,
+ 'processedUser' => $username,
]
);
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to setup manager relationships: ' . $e->getMessage(),
+ 'Failed to setup manager relationships: '.$e->getMessage(),
[
- 'username' => $username,
+ 'username' => $username,
'organization' => $organizationUuid,
- 'exception' => $e
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end setupManagerRelationships()
/**
* Gets organizational hierarchy information for a user
*
* @param string $username The username to get hierarchy for
- *
+ *
* @return array Array containing hierarchy information
*/
public function getUserHierarchy(string $username): array
{
try {
$hierarchy = [
- 'username' => $username,
- 'manager' => null,
- 'subordinates' => [],
- 'organization' => null,
- 'isBeheerder' => false,
- 'isPrimaryManager' => false
+ 'username' => $username,
+ 'manager' => null,
+ 'subordinates' => [],
+ 'organization' => null,
+ 'isBeheerder' => false,
+ 'isPrimaryManager' => false,
];
- // Get user's manager
+ // Get user's manager.
$manager = $this->_contactPersonHandler->getUserManager($username);
- if ($manager) {
+ if ($manager !== null) {
$hierarchy['manager'] = $manager;
}
- // Find subordinates (users who have this user as manager)
- $subordinates = $this->findSubordinates($username);
+ // Find subordinates (users who have this user as manager).
+ $subordinates = $this->findSubordinates(username: $username);
$hierarchy['subordinates'] = $subordinates;
- // Check if user is a beheerder
- $hierarchy['isBeheerder'] = $this->isUserBeheerder($username);
+ // Check if user is a beheerder.
+ $hierarchy['isBeheerder'] = $this->isUserBeheerder(username: $username);
- // Check if user is primary manager (has subordinates and no manager)
- $hierarchy['isPrimaryManager'] = empty($hierarchy['manager']) && !empty($hierarchy['subordinates']);
+ // Check if user is primary manager (has subordinates and no manager).
+ $hierarchy['isPrimaryManager'] = empty($hierarchy['manager']) === true
+ && empty($hierarchy['subordinates']) === false;
return $hierarchy;
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to get user hierarchy: ' . $e->getMessage(),
+ 'Failed to get user hierarchy: '.$e->getMessage(),
[
- 'username' => $username,
- 'exception' => $e
+ 'username' => $username,
+ 'exception' => $e,
]
);
return [];
- }
- }
+ }//end try
+ }//end getUserHierarchy()
/**
* Finds all subordinates for a given user
*
* @param string $username The username to find subordinates for
- *
+ *
* @return array Array of subordinate usernames
*/
private function findSubordinates(string $username): array
{
$subordinates = [];
-
+
try {
- // Get all users and check their managers
+ // Get all users and check their managers.
$userManager = \OC::$server->getUserManager();
- $users = $userManager->search('');
-
+ $users = $userManager->search('');
+
foreach ($users as $user) {
$userUsername = $user->getUID();
- $manager = $this->_contactPersonHandler->getUserManager($userUsername);
-
+ $manager = $this->_contactPersonHandler->getUserManager($userUsername);
+
if ($manager === $username) {
$subordinates[] = $userUsername;
}
}
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to find subordinates: ' . $e->getMessage(),
+ 'Failed to find subordinates: '.$e->getMessage(),
[
- 'username' => $username,
- 'exception' => $e
+ 'username' => $username,
+ 'exception' => $e,
]
);
- }
-
+ }//end try
+
return $subordinates;
- }
+ }//end findSubordinates()
/**
* Checks if a user is a beheerder
*
* @param string $username The username to check
- *
+ *
* @return bool True if user is a beheerder
*/
private function isUserBeheerder(string $username): bool
{
try {
- $groupManager = \OC::$server->getGroupManager();
+ $groupManager = \OC::$server->getGroupManager();
$beheerderGroup = $groupManager->get('beheerder');
-
- if (!$beheerderGroup) {
+
+ if ($beheerderGroup === null) {
return false;
}
-
+
$userManager = \OC::$server->getUserManager();
- $user = $userManager->get($username);
-
- return $user && $beheerderGroup->inGroup($user);
-
+ $user = $userManager->get($username);
+
+ if ($user === null) {
+ return false;
+ }
+
+ return $beheerderGroup->inGroup($user);
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to check if user is beheerder: ' . $e->getMessage(),
+ 'Failed to check if user is beheerder: '.$e->getMessage(),
[
- 'username' => $username,
- 'exception' => $e
+ 'username' => $username,
+ 'exception' => $e,
]
);
return false;
- }
- }
+ }//end try
+ }//end isUserBeheerder()
/**
* Gets complete organizational structure
*
* @param string $organizationUuid The organization UUID
- *
+ *
* @return array Array containing organizational structure
*/
public function getOrganizationStructure(string $organizationUuid): array
{
try {
$structure = [
- 'organization' => $organizationUuid,
- 'beheerders' => [],
+ 'organization' => $organizationUuid,
+ 'beheerders' => [],
'primaryManager' => null,
- 'hierarchy' => []
+ 'hierarchy' => [],
];
- // Get all beheerders for this organization
+ // Get all beheerders for this organization.
$beheerders = $this->_organizationHandler->getOrganizationBeheerders($organizationUuid);
$structure['beheerders'] = $beheerders;
- if (!empty($beheerders)) {
+ if (empty($beheerders) === false) {
$structure['primaryManager'] = $beheerders[0];
}
- // Build hierarchy tree
+ // Build hierarchy tree.
foreach ($beheerders as $beheerder) {
- $hierarchy = $this->getUserHierarchy($beheerder);
+ $hierarchy = $this->getUserHierarchy(username: $beheerder);
$structure['hierarchy'][] = $hierarchy;
}
return $structure;
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to get organization structure: ' . $e->getMessage(),
+ 'Failed to get organization structure: '.$e->getMessage(),
[
'organization' => $organizationUuid,
- 'exception' => $e
+ 'exception' => $e,
]
);
return [];
- }
- }
-}
\ No newline at end of file
+ }//end try
+ }//end getOrganizationStructure()
+}//end class
diff --git a/lib/Service/SoftwareCatalogue/OrganizationHandler.php b/lib/Service/SoftwareCatalogue/OrganizationHandler.php
index 783e9298..4ac8581a 100644
--- a/lib/Service/SoftwareCatalogue/OrganizationHandler.php
+++ b/lib/Service/SoftwareCatalogue/OrganizationHandler.php
@@ -1,7 +1,7 @@
* @license AGPL-3.0-or-later https://www.gnu.org/licenses/agpl-3.0.html
- * @version 1.0.0
+ * @version GIT:
* @link https://github.com/ConductionNL/SoftwareCatalog
*/
@@ -27,25 +27,25 @@
use Psr\Log\LoggerInterface;
/**
- * Handler for organization-related operations
+ * Handler for organization-related operations.
*
* @category Handler
* @package OCA\SoftwareCatalog\Service\SoftwareCatalogue
* @author Conduction b.v.
* @license AGPL-3.0-or-later https://www.gnu.org/licenses/agpl-3.0.html
- * @version 1.0.0
+ * @version GIT:
* @link https://github.com/ConductionNL/SoftwareCatalog
*/
class OrganizationHandler
{
/**
- * OrganizationHandler constructor
+ * OrganizationHandler constructor.
*
- * @param IGroupManager $_groupManager Group manager interface
- * @param IUserManager $_userManager User manager interface
- * @param ContainerInterface $_container Container interface
- * @param IAppManager $_appManager App manager interface
- * @param LoggerInterface $_logger Logger interface
+ * @param IGroupManager $_groupManager Group manager interface
+ * @param IUserManager $_userManager User manager interface
+ * @param ContainerInterface $_container Container interface
+ * @param IAppManager $_appManager App manager interface
+ * @param LoggerInterface $_logger Logger interface
*/
public function __construct(
private readonly IGroupManager $_groupManager,
@@ -54,424 +54,487 @@ public function __construct(
private readonly IAppManager $_appManager,
private readonly LoggerInterface $_logger,
) {
- }
+ }//end __construct()
/**
- * Gets the OpenRegister ObjectService if available
+ * Gets the OpenRegister ObjectService if available.
*
* @return \OCA\OpenRegister\Service\ObjectService|null ObjectService instance or null
+ *
* @throws \RuntimeException If service is not available
*/
- private function _getObjectService(): ?\OCA\OpenRegister\Service\ObjectService
+ private function getObjectService(): ?\OCA\OpenRegister\Service\ObjectService
{
- if (in_array('openregister', $this->_appManager->getInstalledApps())) {
+ if (in_array(needle: 'openregister', haystack: $this->_appManager->getInstalledApps()) === true) {
return $this->_container->get('OCA\OpenRegister\Service\ObjectService');
}
throw new \RuntimeException('OpenRegister service is not available.');
- }
+ }//end getObjectService()
/**
- * Processes organization groups and ensures proper group assignment
+ * Processes organization groups and ensures proper group assignment.
*
* @param object $organizationObject The organization object to process
- *
+ *
* @return bool True if processing was successful
+ *
* @throws \Exception If processing fails
*/
public function processOrganization(object $organizationObject): bool
{
try {
- $this->_logger->info('Processing organization object', [
- 'objectId' => $organizationObject->getId()
- ]);
+ $this->_logger->info(
+ 'Processing organization object',
+ [
+ 'objectId' => $organizationObject->getId(),
+ ]
+ );
$objectData = $organizationObject->getObject();
-
- // Check if organization is active (beoordeling = "actief" or "Actief")
+
+ // Check if organization is active (beoordeling = "actief" or "Actief").
$beoordeling = strtolower($objectData['beoordeling'] ?? '');
if ($beoordeling !== 'actief') {
$this->_logger->info(
'Organization not active, skipping processing',
[
'organizationId' => $organizationObject->getId(),
- 'beoordeling' => $beoordeling
+ 'beoordeling' => $beoordeling,
]
);
- return true; // Not an error, just not ready for processing
+ // Not an error, just not ready for processing.
+ return true;
}
-
- // Ensure organization has a unique group
- $groupId = $this->ensureOrganizationGroup($organizationObject, $objectData);
-
- if ($groupId) {
+
+ // Ensure organization has a unique group.
+ $groupId = $this->ensureOrganizationGroup(
+ organizationObject: $organizationObject,
+ objectData: $objectData
+ );
+
+ if ($groupId !== null) {
$this->_logger->info(
- 'Successfully processed organization group',
+ 'Successfully processed organization group',
[
'organizationId' => $organizationObject->getId(),
- 'groupId' => $groupId
+ 'groupId' => $groupId,
]
);
}
-
+
return true;
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to process organization object: ' . $e->getMessage(),
+ 'Failed to process organization object: '.$e->getMessage(),
[
'exception' => $e,
- 'objectId' => $organizationObject->getId() ?? 'unknown'
+ 'objectId' => $organizationObject->getId() ?? 'unknown',
]
);
throw $e;
- }
- }
+ }//end try
+ }//end processOrganization()
/**
- * Ensures an organization has a unique group and returns the group ID
+ * Ensures an organization has a unique group and returns the group ID.
+ *
+ * @param object $organizationObject The organization object
+ * @param array $objectData The organization data
*
- * @param object $organizationObject The organization object
- * @param array $objectData The organization data
- *
* @return string|null The group ID or null if failed
*/
public function ensureOrganizationGroup(object $organizationObject, array &$objectData): ?string
{
$groupProperty = $objectData['group'] ?? '';
-
- if (empty($groupProperty)) {
- // Create group with organization name
+
+ if (empty($groupProperty) === true) {
+ // Create group with organization name.
$organizationName = $objectData['naam'] ?? $objectData['name'] ?? 'Organization';
- $groupName = $this->sanitizeGroupName($organizationName);
-
- // Ensure group name is unique
- $groupName = $this->ensureUniqueGroupName($groupName);
-
- $group = $this->createGroupIfNotExists($groupName);
-
- if ($group) {
- // Set the group ID in the organization object
+ $groupName = $this->sanitizeGroupName(name: $organizationName);
+
+ // Ensure group name is unique.
+ $groupName = $this->ensureUniqueGroupName(baseName: $groupName);
+
+ $group = $this->createGroupIfNotExists(groupName: $groupName);
+
+ if ($group !== null) {
+ // Set the group ID in the organization object.
$objectData['group'] = $group->getGID();
$organizationObject->setObject($objectData);
-
- // Save the updated organization with correct register/schema IDs
- $objectService = $this->_getObjectService();
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
- $registerId = $settingsService->getVoorzieningenRegisterId();
+
+ // Save the updated organization with correct register/schema IDs.
+ $objectService = $this->getObjectService();
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+ $registerId = $settingsService->getVoorzieningenRegisterId();
$organizationSchemaId = $settingsService->getSchemaIdForObjectType('organisatie');
-
- if ($registerId && $organizationSchemaId) {
+
+ if ($registerId !== null && $organizationSchemaId !== null) {
$objectService->saveObject(
- $organizationObject,
- [],
- (int) $registerId,
- (int) $organizationSchemaId,
- $organizationObject->getUuid()
+ object: $organizationObject,
+ fields: [],
+ register: (int) $registerId,
+ schema: (int) $organizationSchemaId,
+ uuid: $organizationObject->getUuid()
);
} else {
$this->_logger->warning(
'Missing register or schema ID for organization, using fallback save method',
[
- 'registerId' => $registerId,
- 'organizationSchemaId' => $organizationSchemaId
+ 'registerId' => $registerId,
+ 'organizationSchemaId' => $organizationSchemaId,
]
);
$objectService->saveObject($organizationObject);
}
-
+
$this->_logger->info(
'Created and assigned unique group to organization',
[
'organizationId' => $organizationObject->getId(),
- 'groupName' => $groupName,
- 'groupId' => $group->getGID()
+ 'groupName' => $groupName,
+ 'groupId' => $group->getGID(),
]
);
-
+
return $group->getGID();
- }
+ }//end if
+ }//end if
+
+ if (empty($groupProperty) === false) {
+ return $groupProperty;
}
-
- return $groupProperty ?: null;
- }
+
+ return null;
+ }//end ensureOrganizationGroup()
/**
- * Ensures a group name is unique by appending a counter if necessary
+ * Ensures a group name is unique by appending a counter if necessary.
+ *
+ * @param string $baseName The base group name
*
- * @param string $baseName The base group name
- *
* @return string A unique group name
*/
private function ensureUniqueGroupName(string $baseName): string
{
$groupName = $baseName;
- $counter = 1;
-
+ $counter = 1;
+
while ($this->_groupManager->get($groupName) !== null) {
- $groupName = $baseName . '_' . $counter;
+ $groupName = $baseName.'_'.$counter;
$counter++;
}
-
+
return $groupName;
- }
+ }//end ensureUniqueGroupName()
/**
- * Creates a group if it doesn't exist
+ * Creates a group if it doesn't exist.
+ *
+ * @param string $groupName The group name to create
*
- * @param string $groupName The group name to create
- *
* @return IGroup|null The created or existing group
*/
public function createGroupIfNotExists(string $groupName): ?IGroup
{
$group = $this->_groupManager->get($groupName);
-
- if (!$group) {
+
+ if ($group === null) {
try {
$group = $this->_groupManager->createGroup($groupName);
$this->_logger->info(
'Created new group',
[
- 'groupName' => $groupName
+ 'groupName' => $groupName,
]
);
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to create group: ' . $e->getMessage(),
+ 'Failed to create group: '.$e->getMessage(),
[
'groupName' => $groupName,
- 'exception' => $e
+ 'exception' => $e,
]
);
return null;
}
}
-
+
return $group;
- }
+ }//end createGroupIfNotExists()
/**
- * Sanitizes a group name for safe usage
+ * Sanitizes a group name for safe usage.
+ *
+ * @param string $name The name to sanitize
*
- * @param string $name The name to sanitize
- *
* @return string The sanitized group name
*/
public function sanitizeGroupName(string $name): string
{
- // Convert to lowercase and replace special characters
+ // Convert to lowercase and replace special characters.
$sanitized = strtolower(trim($name));
$sanitized = preg_replace('/[^a-z0-9._-]/', '_', $sanitized);
$sanitized = preg_replace('/_{2,}/', '_', $sanitized);
$sanitized = trim($sanitized, '_');
-
- // Ensure it's not empty
- if (empty($sanitized)) {
- $sanitized = 'organization_' . time();
+
+ // Ensure it's not empty.
+ if (empty($sanitized) === true) {
+ $sanitized = 'organization_'.time();
}
-
+
return $sanitized;
- }
+ }//end sanitizeGroupName()
/**
- * Processes contactpersonen from organization data into Contactgegevens objects
+ * Processes contactpersonen from organization data into Contactgegevens objects.
*
* @param object $organizationObject The organization object
- *
+ *
* @return array Array of created or updated contactgegevens objects
*/
public function processContactpersonen(object $organizationObject): array
{
try {
- $objectData = $organizationObject->getObject();
+ $objectData = $organizationObject->getObject();
$contactpersonen = $objectData['contactpersonen'] ?? [];
- // Get the actual UUID from object data instead of database ID
- $organizationUuid = $objectData['id'] ?? $organizationObject->getId();
+ // Get the actual UUID from object data instead of database ID.
+ $organizationUuid = $objectData['id'] ?? $organizationObject->getId();
$processedContacts = [];
- if (!is_array($contactpersonen) || empty($contactpersonen)) {
- $this->_logger->info('No contactpersonen found in organization', [
- 'organizationId' => $organizationUuid
- ]);
+ if (is_array($contactpersonen) === false || empty($contactpersonen) === true) {
+ $this->_logger->info(
+ 'No contactpersonen found in organization',
+ [
+ 'organizationId' => $organizationUuid,
+ ]
+ );
return $processedContacts;
}
- $objectService = $this->_getObjectService();
+ $objectService = $this->getObjectService();
foreach ($contactpersonen as $index => $contactpersoon) {
try {
- // Get the contactgegevens schema ID from settings
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+ // Get the contactgegevens schema ID from settings.
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
$contactgegevensSchemaId = $settingsService->getSchemaIdForObjectType('contactgegevens');
$registerId = $settingsService->getVoorzieningenRegisterId();
-
- if (!$registerId) {
+
+ if ($registerId === null) {
throw new \Exception('Voorzieningen register ID not configured');
}
-
+
$contactEmail = $contactpersoon['email'] ?? $contactpersoon['e-mailadres'] ?? '';
-
- // Check if contactgegevens object already exists for this email + organization
- $existingContactgegevens = $this->findExistingContactgegevens($contactEmail, $organizationUuid, $objectService, $registerId, $contactgegevensSchemaId);
-
+
+ // Check if contactgegevens object already exists for this email + organization.
+ $existingContactgegevens = $this->findExistingContactgegevens(
+ email: $contactEmail,
+ organizationUuid: $organizationUuid,
+ objectService: $objectService,
+ registerId: $registerId,
+ contactgegevensSchemaId: $contactgegevensSchemaId
+ );
+
+ if ($existingContactgegevens !== null) {
+ $logMessage = 'Updating existing contactgegevens object';
+ } else {
+ $logMessage = 'Creating new contactgegevens object';
+ }
+
+ if ($existingContactgegevens !== null) {
+ $existingId = $existingContactgegevens->getUuid();
+ } else {
+ $existingId = null;
+ }
+
$this->_logger->info(
- $existingContactgegevens ? 'Updating existing contactgegevens object' : 'Creating new contactgegevens object',
+ $logMessage,
[
'contactgegevensSchemaId' => $contactgegevensSchemaId,
- 'organizationUuid' => $organizationUuid,
- 'contactpersoonIndex' => $index,
- 'email' => $contactEmail,
- 'existingId' => $existingContactgegevens ? $existingContactgegevens->getUuid() : null
+ 'organizationUuid' => $organizationUuid,
+ 'contactpersoonIndex' => $index,
+ 'email' => $contactEmail,
+ 'existingId' => $existingId,
]
);
-
- // Generate title from name components
- $titleParts = array_filter([
- $contactpersoon['voornaam'] ?? '',
- $contactpersoon['tussenvoegsel'] ?? '',
- $contactpersoon['achternaam'] ?? ''
- ]);
- $title = !empty($titleParts) ? implode(' ', $titleParts) : ($contactpersoon['email'] ?? 'Contact Person');
-
- // Create contactgegevens object with proper schema
+
+ // Generate title from name components.
+ $titleParts = array_filter(
+ [
+ $contactpersoon['voornaam'] ?? '',
+ $contactpersoon['tussenvoegsel'] ?? '',
+ $contactpersoon['achternaam'] ?? '',
+ ]
+ );
+
+ if (empty($titleParts) === false) {
+ $title = implode(' ', $titleParts);
+ } else {
+ $title = $contactpersoon['email'] ?? 'Contact Person';
+ }
+
+ // Create contactgegevens object with proper schema.
+ $contactFunctie = $contactpersoon['functie'] ?? '';
+ $contactRoles = $this->mapFunctieToRoles(
+ functie: $contactFunctie,
+ isFirstContact: ($index === 0)
+ );
$contactgegevensData = [
- 'title' => $title, // Required by OpenRegister
- 'voornaam' => $contactpersoon['voornaam'] ?? '',
+ // Required by OpenRegister.
+ 'title' => $title,
+ 'voornaam' => $contactpersoon['voornaam'] ?? '',
'tussenvoegsel' => $contactpersoon['tussenvoegsel'] ?? '',
- 'achternaam' => $contactpersoon['achternaam'] ?? '',
- 'telefoon' => $contactpersoon['telefoon'] ?? '',
- 'email' => $contactEmail,
- 'functie' => $contactpersoon['functie'] ?? '',
- 'organisation' => $organizationUuid, // Link to organization
- 'roles' => $this->mapFunctieToRoles($contactpersoon['functie'] ?? '', $index === 0),
- 'username' => '', // Will be set when user is created
+ 'achternaam' => $contactpersoon['achternaam'] ?? '',
+ 'telefoon' => $contactpersoon['telefoon'] ?? '',
+ 'email' => $contactEmail,
+ 'functie' => $contactFunctie,
+ // Link to organization.
+ 'organisation' => $organizationUuid,
+ 'roles' => $contactRoles,
+ // Will be set when user is created.
+ 'username' => '',
];
- // If updating existing contactgegevens, preserve the username if it exists
- if ($existingContactgegevens) {
+ // If updating existing contactgegevens, preserve the username if it exists.
+ if ($existingContactgegevens !== null) {
$existingData = $existingContactgegevens->getObject();
$contactgegevensData['username'] = $existingData['username'] ?? '';
}
- // Create or update the contactgegevens object via ObjectService
- if ($existingContactgegevens) {
- // Update existing contactgegevens object
+ // Create or update the contactgegevens object via ObjectService.
+ if ($existingContactgegevens !== null) {
+ // Update existing contactgegevens object.
$contactgegevensObject = $objectService->saveObject(
- $contactgegevensData,
- [],
- $registerId, // Dynamic register ID from configuration
- $contactgegevensSchemaId, // Schema ID from configuration
- $existingContactgegevens->getUuid() // Pass existing UUID to update
+ object: $contactgegevensData,
+ fields: [],
+ register: $registerId,
+ schema: $contactgegevensSchemaId,
+ uuid: $existingContactgegevens->getUuid()
);
} else {
- // Create new contactgegevens object
+ // Create new contactgegevens object.
$contactgegevensObject = $objectService->saveObject(
- $contactgegevensData,
- [],
- $registerId, // Dynamic register ID from configuration
- $contactgegevensSchemaId // Schema ID from configuration
+ object: $contactgegevensData,
+ fields: [],
+ register: $registerId,
+ schema: $contactgegevensSchemaId
);
- }
-
- if ($contactgegevensObject) {
+ }//end if
+
+ if ($contactgegevensObject !== null) {
$processedContacts[] = $contactgegevensObject;
-
+
+ if ($existingContactgegevens !== null) {
+ $actionLogMessage = 'Updated existing contactgegevens from contactpersoon';
+ $actionValue = 'update';
+ } else {
+ $actionLogMessage = 'Created new contactgegevens from contactpersoon';
+ $actionValue = 'create';
+ }
+
$this->_logger->info(
- $existingContactgegevens ? 'Updated existing contactgegevens from contactpersoon' : 'Created new contactgegevens from contactpersoon',
+ $actionLogMessage,
[
- 'organizationId' => $organizationUuid,
- 'contactgegevensId' => $contactgegevensObject->getId(),
+ 'organizationId' => $organizationUuid,
+ 'contactgegevensId' => $contactgegevensObject->getId(),
'contactpersoonIndex' => $index,
- 'email' => $contactgegevensData['email'],
- 'action' => $existingContactgegevens ? 'update' : 'create'
+ 'email' => $contactgegevensData['email'],
+ 'action' => $actionValue,
]
);
- }
-
+ }//end if
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to process contactpersoon: ' . $e->getMessage(),
+ 'Failed to process contactpersoon: '.$e->getMessage(),
[
- 'organizationId' => $organizationUuid,
+ 'organizationId' => $organizationUuid,
'contactpersoonIndex' => $index,
- 'contactpersoon' => $contactpersoon,
- 'exception' => $e
+ 'contactpersoon' => $contactpersoon,
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end foreach
return $processedContacts;
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to process contactpersonen: ' . $e->getMessage(),
+ 'Failed to process contactpersonen: '.$e->getMessage(),
[
'organizationId' => $organizationObject->getId(),
- 'exception' => $e
+ 'exception' => $e,
]
);
return [];
- }
- }
+ }//end try
+ }//end processContactpersonen()
/**
- * Finds existing contactgegevens object for a given email and organization
+ * Finds existing contactgegevens object for a given email and organization.
+ *
+ * @param string $email The email address to search for
+ * @param string $organizationUuid The organization UUID
+ * @param \OCA\OpenRegister\Service\ObjectService $objectService The object service
+ * @param int $registerId The register ID
+ * @param int $contactgegevensSchemaId The contactgegevens schema ID
*
- * @param string $email The email address to search for
- * @param string $organizationUuid The organization UUID
- * @param \OCA\OpenRegister\Service\ObjectService $objectService The object service
- * @param int $registerId The register ID
- * @param int $contactgegevensSchemaId The contactgegevens schema ID
- *
* @return object|null The existing contactgegevens object or null if not found
*/
- private function findExistingContactgegevens(string $email, string $organizationUuid, \OCA\OpenRegister\Service\ObjectService $objectService, int $registerId, int $contactgegevensSchemaId): ?object
- {
+ private function findExistingContactgegevens(
+ string $email,
+ string $organizationUuid,
+ \OCA\OpenRegister\Service\ObjectService $objectService,
+ int $registerId,
+ int $contactgegevensSchemaId
+ ): ?object {
try {
- if (empty($email) || empty($organizationUuid)) {
+ if (empty($email) === true || empty($organizationUuid) === true) {
return null;
}
- // Search for existing contactgegevens with this email and organization
+ // Search for existing contactgegevens with this email and organization.
$searchFilters = [
- 'email' => $email,
- 'organisation' => $organizationUuid
+ 'email' => $email,
+ 'organisation' => $organizationUuid,
];
- $existingObjects = $objectService->findAll($searchFilters, $registerId, $contactgegevensSchemaId);
+ $existingObjects = $objectService->findAll(
+ filters: $searchFilters,
+ register: $registerId,
+ schema: $contactgegevensSchemaId
+ );
- if (!empty($existingObjects)) {
+ if (empty($existingObjects) === false) {
$this->_logger->info(
'Found existing contactgegevens object',
[
- 'email' => $email,
+ 'email' => $email,
'organizationUuid' => $organizationUuid,
- 'existingId' => $existingObjects[0]->getUuid(),
- 'totalFound' => count($existingObjects)
+ 'existingId' => $existingObjects[0]->getUuid(),
+ 'totalFound' => count($existingObjects),
]
);
- return $existingObjects[0]; // Return the first match
+ // Return the first match.
+ return $existingObjects[0];
}
return null;
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to find existing contactgegevens: ' . $e->getMessage(),
+ 'Failed to find existing contactgegevens: '.$e->getMessage(),
[
- 'email' => $email,
+ 'email' => $email,
'organizationUuid' => $organizationUuid,
- 'exception' => $e
+ 'exception' => $e,
]
);
return null;
- }
- }
+ }//end try
+ }//end findExistingContactgegevens()
/**
- * Gets all available roles in the system
+ * Gets all available roles in the system.
*
* @return array Array of all available roles
*/
@@ -483,198 +546,221 @@ private function getAllAvailableRoles(): array
'Gebruik-beheerder',
'Gebruik-raadpleger',
'VNG-raadpleger',
- 'beheerder' // Add beheerder role for group assignment
+ // Add beheerder role for group assignment.
+ 'beheerder',
];
- }
+ }//end getAllAvailableRoles()
/**
- * Maps functie (job function) to appropriate roles
+ * Maps functie (job function) to appropriate roles.
*
- * @param string $functie The job function
+ * @param string $functie The job function
* @param bool $isFirstContact Whether this is the first contact in the organization
- *
+ *
* @return array Array of roles
*/
- private function mapFunctieToRoles(string $functie, bool $isFirstContact = false): array
+ private function mapFunctieToRoles(string $functie, bool $isFirstContact=false): array
{
- // If this is the first contact, give them all available roles
- if ($isFirstContact) {
+ // If this is the first contact, give them all available roles.
+ if ($isFirstContact === true) {
$this->_logger->info('Assigning all roles to first contact', ['functie' => $functie]);
return $this->getAllAvailableRoles();
}
-
+
$functie = strtolower(trim($functie));
-
- // Default role mappings based on common job functions
+
+ // Default role mappings based on common job functions.
$roleMapping = [
- 'ceo' => ['Functioneel-beheerder', 'Aanbod-beheerder'],
- 'manager' => ['Functioneel-beheerder', 'Gebruik-beheerder'],
- 'beheerder' => ['Gebruik-beheerder', 'beheerder'],
+ 'ceo' => ['Functioneel-beheerder', 'Aanbod-beheerder'],
+ 'manager' => ['Functioneel-beheerder', 'Gebruik-beheerder'],
+ 'beheerder' => ['Gebruik-beheerder', 'beheerder'],
'administrator' => ['Functioneel-beheerder'],
- 'inkoper' => ['Gebruik-beheerder'],
- 'procurement' => ['Gebruik-beheerder'],
- 'raadpleger' => ['Gebruik-raadpleger'],
- 'viewer' => ['Gebruik-raadpleger'],
- 'vng' => ['VNG-raadpleger']
+ 'inkoper' => ['Gebruik-beheerder'],
+ 'procurement' => ['Gebruik-beheerder'],
+ 'raadpleger' => ['Gebruik-raadpleger'],
+ 'viewer' => ['Gebruik-raadpleger'],
+ 'vng' => ['VNG-raadpleger'],
];
- // Check for specific matches
+ // Check for specific matches.
foreach ($roleMapping as $key => $roles) {
- if (strpos($functie, $key) !== false) {
+ if (strpos(haystack: $functie, needle: $key) !== false) {
return $roles;
}
}
- // Default role for unknown functions
+ // Default role for unknown functions.
return ['Gebruik-raadpleger'];
- }
+ }//end mapFunctieToRoles()
/**
- * Handles new organization creation with contactpersonen processing
+ * Handles new organization creation with contactpersonen processing.
+ *
+ * @param object $organizationObject The organization object
*
- * @param object $organizationObject The organization object
- *
* @return void
*/
public function handleNewOrganization(object $organizationObject): void
{
try {
- $this->_logger->info('Handling new organization', [
- 'objectId' => $organizationObject->getId()
- ]);
-
- // First process the organization to ensure it has proper group structure
- $processed = $this->processOrganization($organizationObject);
-
- if ($processed) {
- // Then process contactpersonen if organization is active
- $objectData = $organizationObject->getObject();
+ $this->_logger->info(
+ 'Handling new organization',
+ [
+ 'objectId' => $organizationObject->getId(),
+ ]
+ );
+
+ // First process the organization to ensure it has proper group structure.
+ $processed = $this->processOrganization(organizationObject: $organizationObject);
+
+ if ($processed === true) {
+ // Then process contactpersonen if organization is active.
+ $objectData = $organizationObject->getObject();
$beoordeling = strtolower($objectData['beoordeling'] ?? '');
-
+
if ($beoordeling === 'actief') {
- $processedContacts = $this->processContactpersonen($organizationObject);
-
+ $processedContacts = $this->processContactpersonen(organizationObject: $organizationObject);
+
$this->_logger->info(
'Processed organization and contactgegevens',
[
- 'organizationId' => $organizationObject->getId(),
- 'contactgegevensCount' => count($processedContacts)
+ 'organizationId' => $organizationObject->getId(),
+ 'contactgegevensCount' => count($processedContacts),
]
);
}
}
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to handle new organization: ' . $e->getMessage(),
+ 'Failed to handle new organization: '.$e->getMessage(),
[
- 'objectId' => $organizationObject->getId(),
- 'exception' => $e
+ 'objectId' => $organizationObject->getId(),
+ 'exception' => $e,
]
);
- }
- }
+ }//end try
+ }//end handleNewOrganization()
/**
- * Gets all beheerders for an organization
+ * Gets all beheerders for an organization.
+ *
+ * @param string $organizationUuid The organization UUID
*
- * @param string $organizationUuid The organization UUID
- *
* @return array Array of usernames who are beheerders in this organization
*/
public function getOrganizationBeheerders(string $organizationUuid): array
{
try {
- $beheerders = [];
+ $beheerders = [];
$beheerderGroup = $this->_groupManager->get('beheerder');
-
- if (!$beheerderGroup) {
+
+ if ($beheerderGroup === null) {
return [];
}
-
- // Get all users in beheerder group
+
+ // Get all users in beheerder group.
$beheerderUsers = $beheerderGroup->getUsers();
-
- // Filter users who belong to this organization
+
+ // Filter users who belong to this organization.
foreach ($beheerderUsers as $user) {
- if ($this->userBelongsToOrganization($user, $organizationUuid)) {
+ if ($this->userBelongsToOrganization(user: $user, organizationUuid: $organizationUuid) === true) {
$beheerders[] = $user->getUID();
}
}
-
- // Sort by user creation date (oldest first)
- usort($beheerders, function($a, $b) {
- $userA = $this->_userManager->get($a);
- $userB = $this->_userManager->get($b);
-
- // Get user creation timestamps (fallback to 0 if not available)
- $timeA = $userA ? ($userA->getLastLogin() ?: 0) : 0;
- $timeB = $userB ? ($userB->getLastLogin() ?: 0) : 0;
-
- return $timeA <=> $timeB;
- });
-
+
+ // Sort by user creation date (oldest first).
+ usort(
+ $beheerders,
+ function ($a, $b) {
+ $userA = $this->_userManager->get($a);
+ $userB = $this->_userManager->get($b);
+
+ // Get user creation timestamps (fallback to 0 if not available).
+ if ($userA !== null) {
+ $lastLoginA = $userA->getLastLogin();
+ if ($lastLoginA !== 0 && $lastLoginA !== null && $lastLoginA !== false) {
+ $timeA = $lastLoginA;
+ } else {
+ $timeA = 0;
+ }
+ } else {
+ $timeA = 0;
+ }
+
+ if ($userB !== null) {
+ $lastLoginB = $userB->getLastLogin();
+ if ($lastLoginB !== 0 && $lastLoginB !== null && $lastLoginB !== false) {
+ $timeB = $lastLoginB;
+ } else {
+ $timeB = 0;
+ }
+ } else {
+ $timeB = 0;
+ }
+
+ return $timeA <=> $timeB;
+ }
+ );
+
$this->_logger->info(
'Found organization beheerders',
[
'organization' => $organizationUuid,
- 'beheerders' => $beheerders
+ 'beheerders' => $beheerders,
]
);
-
+
return $beheerders;
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to get organization beheerders: ' . $e->getMessage(),
+ 'Failed to get organization beheerders: '.$e->getMessage(),
[
'organization' => $organizationUuid,
- 'exception' => $e
+ 'exception' => $e,
]
);
return [];
- }
- }
+ }//end try
+ }//end getOrganizationBeheerders()
/**
- * Checks if a user belongs to an organization
+ * Checks if a user belongs to an organization.
+ *
+ * @param IUser $user The user to check
+ * @param string $organizationUuid The organization UUID
*
- * @param IUser $user The user to check
- * @param string $organizationUuid The organization UUID
- *
* @return bool True if user belongs to organization
*/
public function userBelongsToOrganization(IUser $user, string $organizationUuid): bool
{
try {
- // Check if user is in the organization-specific group
- $organizationGroupName = $this->sanitizeGroupName($organizationUuid);
- $organizationGroup = $this->_groupManager->get($organizationGroupName);
-
- if ($organizationGroup && $organizationGroup->inGroup($user)) {
+ // Check if user is in the organization-specific group.
+ $organizationGroupName = $this->sanitizeGroupName(name: $organizationUuid);
+ $organizationGroup = $this->_groupManager->get($organizationGroupName);
+
+ if ($organizationGroup !== null && $organizationGroup->inGroup($user) === true) {
return true;
}
-
- // Alternative approach: check user's groups for organization-specific groups
+
+ // Alternative approach: check user's groups for organization-specific groups.
$userGroups = $this->_groupManager->getUserGroups($user);
foreach ($userGroups as $group) {
- // Check if any group name contains the organization UUID
- if (strpos($group->getGID(), $organizationUuid) !== false) {
+ // Check if any group name contains the organization UUID.
+ if (strpos(haystack: $group->getGID(), needle: $organizationUuid) !== false) {
return true;
}
}
-
+
return false;
-
} catch (\Exception $e) {
$this->_logger->error(
- 'Failed to check user organization membership: ' . $e->getMessage(),
+ 'Failed to check user organization membership: '.$e->getMessage(),
[
- 'username' => $user->getUID(),
- 'organization' => $organizationUuid
+ 'username' => $user->getUID(),
+ 'organization' => $organizationUuid,
]
);
return false;
- }
- }
-}
\ No newline at end of file
+ }//end try
+ }//end userBelongsToOrganization()
+}//end class
diff --git a/lib/Service/SoftwareCatalogueService.php b/lib/Service/SoftwareCatalogueService.php
index c4e2608d..2c6b4bec 100644
--- a/lib/Service/SoftwareCatalogueService.php
+++ b/lib/Service/SoftwareCatalogueService.php
@@ -3,14 +3,13 @@
/**
* Software Catalogue Service
*
- * Service for handling software catalog specific operations including
+ * Service for handling software catalog specific operations including
* user management, contact processing, and object lifecycle management.
*
* @category Service
* @package OCA\SoftwareCatalog\Service
* @author Conduction b.v.
* @license AGPL-3.0-or-later https://www.gnu.org/licenses/agpl-3.0.html
- * @version 1.0.0
* @link https://github.com/ConductionNL/SoftwareCatalog
*/
@@ -28,7 +27,7 @@
use OCP\App\IAppManager;
/**
- * Service for handling software catalog operations
+ * Service for handling software catalog operations.
*
* Provides functionality for user management, contact processing,
* email notifications, and object lifecycle management.
@@ -37,27 +36,29 @@
* @package OCA\SoftwareCatalog\Service
* @author Conduction b.v.
* @license AGPL-3.0-or-later https://www.gnu.org/licenses/agpl-3.0.html
- * @version 1.0.0
* @link https://github.com/ConductionNL/SoftwareCatalog
*/
class SoftwareCatalogueService
{
+
/**
* The name of the app
*
* @var string
*/
- private string $_appName;
+ private string $appName;
/**
* SoftwareCatalogueService constructor
*
- * @param OrganizationHandler $_organizationHandler Organization handler
- * @param ContactPersonHandler $_contactPersonHandler Contact person handler
- * @param GroupHandler $_groupHandler Group handler
- * @param HierarchyHandler $_hierarchyHandler Hierarchy handler
- * @param SymfonyEmailService $_emailService Email service
- * @param LoggerInterface $_logger Logger interface
+ * @param OrganizationHandler $_organizationHandler Organization handler.
+ * @param ContactPersonHandler $_contactPersonHandler Contact person handler.
+ * @param GroupHandler $_groupHandler Group handler.
+ * @param HierarchyHandler $_hierarchyHandler Hierarchy handler.
+ * @param SymfonyEmailService $_emailService Email service.
+ * @param LoggerInterface $_logger Logger interface.
+ * @param ContainerInterface $_container Container interface.
+ * @param IAppManager $_appManager App manager interface.
*/
public function __construct(
private readonly OrganizationHandler $_organizationHandler,
@@ -70,45 +71,45 @@ public function __construct(
private readonly IAppManager $_appManager,
) {
$this->_appName = 'softwarecatalog';
- }
+ }//end __construct()
/**
* Gets the ObjectService instance
*
* @return \OCA\OpenRegister\Service\ObjectService|null
*/
- private function _getObjectService(): ?\OCA\OpenRegister\Service\ObjectService
+ private function getObjectService(): ?\OCA\OpenRegister\Service\ObjectService
{
- if (!$this->_appManager->isEnabledForUser('openregister')) {
+ if ($this->_appManager->isEnabledForUser(appId: 'openregister') === false) {
return null;
}
try {
return $this->_container->get('OCA\\OpenRegister\\Service\\ObjectService');
} catch (\Exception $e) {
- $this->_logger->error('Failed to get ObjectService: ' . $e->getMessage());
+ $this->_logger->error('Failed to get ObjectService: '.$e->getMessage());
return null;
}
- }
+ }//end getObjectService()
/**
* Gets the OrganisationService instance
*
* @return \OCA\OpenRegister\Service\OrganisationService|null
*/
- private function _getOrganisationService(): ?\OCA\OpenRegister\Service\OrganisationService
+ private function getOrganisationService(): ?\OCA\OpenRegister\Service\OrganisationService
{
- if (!$this->_appManager->isEnabledForUser('openregister')) {
+ if ($this->_appManager->isEnabledForUser(appId: 'openregister') === false) {
return null;
}
try {
return $this->_container->get('OCA\\OpenRegister\\Service\\OrganisationService');
} catch (\Exception $e) {
- $this->_logger->error('Failed to get OrganisationService: ' . $e->getMessage());
+ $this->_logger->error('Failed to get OrganisationService: '.$e->getMessage());
return null;
}
- }
+ }//end getOrganisationService()
/**
* Processes a contactpersoon object to create an inactive user
@@ -118,159 +119,202 @@ private function _getOrganisationService(): ?\OCA\OpenRegister\Service\Organisat
*
* @param object $contactpersoonObject The contactpersoon object to process
* @param bool $isUpdate Whether this is an update operation (defaults to false)
- *
+ *
* @return bool True if processing was successful
* @throws \Exception If processing fails
*/
- public function processContactpersoon(object $contactpersoonObject, bool $isUpdate = false): bool
+ public function processContactpersoon(object $contactpersoonObject, bool $isUpdate=false): bool
{
$startTime = microtime(true);
-
+
try {
- $objectId = $contactpersoonObject->getId();
+ $objectId = $contactpersoonObject->getId();
$objectData = $contactpersoonObject->getObject();
-
- $this->_logger->info('SoftwareCatalogueService: Starting contactpersoon processing', [
- 'objectId' => $objectId,
- 'objectData' => $objectData,
- 'timestamp' => date('Y-m-d H:i:s')
- ]);
-
- // Delegate to contact person handler
- $this->_logger->debug('SoftwareCatalogueService: Delegating to ContactPersonHandler for contactpersoon processing', [
- 'objectId' => $objectId
- ]);
-
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Starting contactpersoon processing',
+ [
+ 'objectId' => $objectId,
+ 'objectData' => $objectData,
+ 'timestamp' => date('Y-m-d H:i:s'),
+ ]
+ );
+
+ // Delegate to contact person handler.
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Delegating to ContactPersonHandler for contactpersoon processing',
+ [
+ 'objectId' => $objectId,
+ ]
+ );
+
$result = $this->_contactPersonHandler->processContactpersoon($contactpersoonObject, $isUpdate);
-
- $this->_logger->info('SoftwareCatalogueService: ContactPersonHandler processing completed', [
- 'objectId' => $objectId,
- 'result' => $result,
- 'processingTime' => round((microtime(true) - $startTime) * 1000, 2) . 'ms'
- ]);
-
- if ($result) {
- // Get the username from the processed object
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: ContactPersonHandler processing completed',
+ [
+ 'objectId' => $objectId,
+ 'result' => $result,
+ 'processingTime' => round((microtime(true) - $startTime) * 1000, 2).'ms',
+ ]
+ );
+
+ if (empty($result) === false) {
+ // Get the username from the processed object.
$updatedObjectData = $contactpersoonObject->getObject();
- $username = $updatedObjectData['username'] ?? '';
-
- $this->_logger->info('SoftwareCatalogueService: Username extracted from processed object', [
- 'objectId' => $objectId,
- 'username' => $username,
- 'hasUsername' => !empty($username)
- ]);
-
- if (!empty($username)) {
- // NOTE: Group assignment is already handled by ContactPersonHandler.assignUserGroups()
- // during user creation, so we don't need to call GroupHandler.updateUserGroups() here
+ $username = $updatedObjectData['username'] ?? '';
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Username extracted from processed object',
+ [
+ 'objectId' => $objectId,
+ 'username' => $username,
+ 'hasUsername' => empty($username) === false,
+ ]
+ );
+
+ if (empty($username) === false) {
+ // NOTE: Group assignment is already handled by ContactPersonHandler.assignUserGroups().
+ // during user creation, so we don't need to call GroupHandler.updateUserGroups() here.
// as it would overwrite the correct group assignments.
-
- // Ensure organization has beheerder and set up manager relationships
- $this->_logger->debug('SoftwareCatalogueService: Ensuring organization beheerder', [
- 'objectId' => $objectId,
- 'username' => $username
- ]);
-
+ // Ensure organization has beheerder and set up manager relationships.
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Ensuring organization beheerder',
+ [
+ 'objectId' => $objectId,
+ 'username' => $username,
+ ]
+ );
+
$this->_hierarchyHandler->ensureOrganizationBeheerder($contactpersoonObject, $username);
-
- // Set user to inactive initially
- $this->_logger->debug('SoftwareCatalogueService: Setting user to inactive', [
- 'objectId' => $objectId,
- 'username' => $username
- ]);
-
+
+ // Set user to inactive initially.
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Setting user to inactive',
+ [
+ 'objectId' => $objectId,
+ 'username' => $username,
+ ]
+ );
+
$this->_contactPersonHandler->setUserInactive($username);
-
- $this->_logger->info('SoftwareCatalogueService: User setup completed', [
- 'objectId' => $objectId,
- 'username' => $username,
- 'totalProcessingTime' => round((microtime(true) - $startTime) * 1000, 2) . 'ms'
- ]);
-
- // Add the newly created user to the organization entity
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: User setup completed',
+ [
+ 'objectId' => $objectId,
+ 'username' => $username,
+ 'totalProcessingTime' => round((microtime(true) - $startTime) * 1000, 2).'ms',
+ ]
+ );
+
+ // Add the newly created user to the organization entity.
$organisatie = $objectData['organisatie'] ?? null;
- if ($organisatie) {
- $this->_logger->info('SoftwareCatalogueService: Adding user to organization entity', [
- 'objectId' => $objectId,
- 'username' => $username,
- 'organisatie' => $organisatie
- ]);
-
+ if (empty($organisatie) === false) {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Adding user to organization entity',
+ [
+ 'objectId' => $objectId,
+ 'username' => $username,
+ 'organisatie' => $organisatie,
+ ]
+ );
+
try {
$organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
- $organisation = $organisationMapper->findByUuid($organisatie);
-
- if ($organisation) {
+ $organisation = $organisationMapper->findByUuid($organisatie);
+
+ if (empty($organisation) === false) {
$currentUsers = $organisation->getUsers() ?? [];
- if (!in_array($username, $currentUsers)) {
+ if (in_array($username, $currentUsers) === false) {
$currentUsers[] = $username;
$organisation->setUsers($currentUsers);
$organisationMapper->save($organisation);
-
- $this->_logger->info('SoftwareCatalogueService: Successfully added user to organization entity', [
- 'objectId' => $objectId,
- 'username' => $username,
- 'organisatie' => $organisatie,
- 'totalUsers' => count($currentUsers)
- ]);
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully added user to organization entity',
+ [
+ 'objectId' => $objectId,
+ 'username' => $username,
+ 'organisatie' => $organisatie,
+ 'totalUsers' => count($currentUsers),
+ ]
+ );
} else {
- $this->_logger->info('SoftwareCatalogueService: User already in organization entity', [
- 'objectId' => $objectId,
- 'username' => $username,
- 'organisatie' => $organisatie
- ]);
- }
+ $this->_logger->info(
+ 'SoftwareCatalogueService: User already in organization entity',
+ [
+ 'objectId' => $objectId,
+ 'username' => $username,
+ 'organisatie' => $organisatie,
+ ]
+ );
+ }//end if
} else {
- $this->_logger->warning('SoftwareCatalogueService: Organization entity not found', [
- 'objectId' => $objectId,
- 'username' => $username,
- 'organisatie' => $organisatie
- ]);
- }
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Organization entity not found',
+ [
+ 'objectId' => $objectId,
+ 'username' => $username,
+ 'organisatie' => $organisatie,
+ ]
+ );
+ }//end if
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: Failed to add user to organization entity', [
- 'objectId' => $objectId,
- 'username' => $username,
- 'organisatie' => $organisatie,
- 'error' => $e->getMessage()
- ]);
- }
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Failed to add user to organization entity',
+ [
+ 'objectId' => $objectId,
+ 'username' => $username,
+ 'organisatie' => $organisatie,
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
} else {
- $this->_logger->warning('SoftwareCatalogueService: No organisation reference found for contact person', [
- 'objectId' => $objectId,
- 'username' => $username
- ]);
- }
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: No organisation reference found for contact person',
+ [
+ 'objectId' => $objectId,
+ 'username' => $username,
+ ]
+ );
+ }//end if
} else {
- $this->_logger->warning('SoftwareCatalogueService: No username generated for contactpersoon', [
- 'objectId' => $objectId,
- 'objectData' => $updatedObjectData
- ]);
- }
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: No username generated for contactpersoon',
+ [
+ 'objectId' => $objectId,
+ 'objectData' => $updatedObjectData,
+ ]
+ );
+ }//end if
} else {
- $this->_logger->warning('SoftwareCatalogueService: ContactPersonHandler returned false', [
- 'objectId' => $objectId,
- 'processingTime' => round((microtime(true) - $startTime) * 1000, 2) . 'ms'
- ]);
- }
-
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: ContactPersonHandler returned false',
+ [
+ 'objectId' => $objectId,
+ 'processingTime' => round((microtime(true) - $startTime) * 1000, 2).'ms',
+ ]
+ );
+ }//end if
+
return $result;
-
} catch (\Exception $e) {
$this->_logger->error(
- 'SoftwareCatalogueService: Failed to process contactpersoon object: ' . $e->getMessage(),
+ 'SoftwareCatalogueService: Failed to process contactpersoon object: '.$e->getMessage(),
[
- 'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString(),
- 'objectId' => $contactpersoonObject->getId() ?? 'unknown',
- 'processingTime' => round((microtime(true) - $startTime) * 1000, 2) . 'ms'
+ 'exception' => $e->getMessage(),
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
+ 'objectId' => $contactpersoonObject->getId() ?? 'unknown',
+ 'processingTime' => round((microtime(true) - $startTime) * 1000, 2).'ms',
]
);
throw $e;
- }
- }
+ }//end try
+ }//end processContactpersoon()
/**
* Processes a contactpersoon object to ensure it has a username
@@ -279,712 +323,668 @@ public function processContactpersoon(object $contactpersoonObject, bool $isUpda
* this method will create a user account and set the username property.
*
* @param object $contactpersoonObject The contactpersoon object to process
- *
+ *
* @return bool True if processing was successful
* @throws \Exception If processing fails
*/
-
/**
* Processes organization without contactpersonen processing
- *
- * @deprecated This method is disabled to prevent organization duplication
- * @param object $organizationObject The organization object to process
- *
- * @return bool True if processing was successful
- * @throws \Exception If processing fails
+ *
+ * @param object $organizationObject The organization object to process.
+ *
+ * @return bool True if processing was successful.
+ * @throws \Exception If processing fails.
+ *
+ * @deprecated This method is disabled to prevent organization duplication.
*/
public function processOrganization(object $organizationObject): bool
{
- // DISABLED: Organization processing is disabled to prevent duplication
+ // DISABLED: Organization processing is disabled to prevent duplication.
$this->_logger->info(
'Organization processing is disabled to prevent duplication',
[
- 'organizationId' => $organizationObject->getId()
+ 'organizationId' => $organizationObject->getId(),
]
);
-
+
return false;
-
- /*
- try {
- // Delegate to organization handler for basic processing
- $processed = $this->_organizationHandler->processOrganization($organizationObject);
-
- $this->_logger->info(
- 'Successfully processed organization without contactpersonen',
- [
- 'organizationId' => $organizationObject->getId()
- ]
- );
-
- return $processed;
-
- } catch (\Exception $e) {
- $this->_logger->error(
- 'Failed to process organization: ' . $e->getMessage(),
- [
- 'organizationId' => $organizationObject->getId(),
- 'exception' => $e
- ]
- );
- throw $e;
- }
- */
- }
+
+ // Disabled: organization processing logic removed.
+ }//end processOrganization()
/**
* Updates user groups based on contactpersoon data
*
* @param object $contactpersoonObject The contactpersoon object
- * @param string $username The username to update groups for
- *
+ * @param string $username The username to update groups for
+ *
* @return void
*/
public function updateUserGroups(object $contactpersoonObject, string $username): void
{
- // Use the new organization type-based logic instead of old role-based logic
- $user = $this->_userManager->get($username);
- if ($user) {
+ // Use the new organization type-based logic instead of old role-based logic.
+ $user = $this->_container->get(\OCP\IUserManager::class)->get($username);
+ if (empty($user) === false) {
$contactData = $contactpersoonObject->getObject();
$this->_contactPersonHandler->updateUserGroupsFromContactData($user, $contactData);
} else {
$this->_logger->warning('User not found for group update', ['username' => $username]);
}
- }
+ }//end updateUserGroups()
/**
* Ensures organization has at least one beheerder and manages user hierarchy
*
* @param object $contactpersoonObject The contactpersoon object
- * @param string $username The username being processed
- *
+ * @param string $username The username being processed
+ *
* @return void
*/
public function ensureOrganizationBeheerder(object $contactpersoonObject, string $username): void
{
- // Delegate to hierarchy handler
+ // Delegate to hierarchy handler.
$this->_hierarchyHandler->ensureOrganizationBeheerder($contactpersoonObject, $username);
- }
+ }//end ensureOrganizationBeheerder()
/**
* Gets a user's manager
*
* @param string $username The username
- *
+ *
* @return string|null The manager's username or null if not set
*/
public function getUserManager(string $username): ?string
{
- // Delegate to contact person handler
+ // Delegate to contact person handler.
return $this->_contactPersonHandler->getUserManager($username);
- }
+ }//end getUserManager()
/**
* Handles new organization creation - syncs with OpenRegister and processes organization
*
* @param object $organizationObject The new organization object
- *
+ *
* @return void
*/
public function handleNewOrganization(object $organizationObject): void
{
try {
- $this->_logger->info('SoftwareCatalogueService: Handling new organization', [
- 'objectId' => $organizationObject->getId()
- ]);
-
- // First, sync the organization with OpenRegister
- $syncResult = $this->syncOrganizationWithOpenRegister($organizationObject);
-
- if ($syncResult) {
- $this->_logger->info('SoftwareCatalogueService: Successfully synced organization with OpenRegister', [
- 'objectId' => $organizationObject->getId()
- ]);
-
- // Update organization references on objects to point to the newly created organization entity
- $this->updateOrganizationReferences($organizationObject);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Handling new organization',
+ [
+ 'objectId' => $organizationObject->getId(),
+ ]
+ );
+
+ // First, sync the organization with OpenRegister.
+ $syncResult = $this->syncOrganizationWithOpenRegister(organizationObject: $organizationObject);
+
+ if (empty($syncResult) === false) {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully synced organization with OpenRegister',
+ [
+ 'objectId' => $organizationObject->getId(),
+ ]
+ );
+
+ // Update organization references on objects to point to the newly created organization entity.
+ $this->updateOrganizationReferences(organizationObject: $organizationObject);
} else {
- $this->_logger->warning('SoftwareCatalogueService: Failed to sync organization with OpenRegister', [
- 'objectId' => $organizationObject->getId()
- ]);
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Failed to sync organization with OpenRegister',
+ [
+ 'objectId' => $organizationObject->getId(),
+ ]
+ );
}
- // Process the organization (existing functionality) - this creates users
- $this->processOrganization($organizationObject);
-
- // Add all admin group users to the organization
- $objectData = $organizationObject->getObject();
+ // Process the organization (existing functionality) - this creates users.
+ $this->processOrganization(organizationObject: $organizationObject);
+
+ // Add all admin group users to the organization.
+ $objectData = $organizationObject->getObject();
$organizationUuid = $objectData['id'] ?? $organizationObject->getId();
- $this->addAdminGroupUsersToOrganization($organizationUuid);
-
- // Handle ownership assignment for anonymous user registrations AFTER user creation
- $this->handleOwnershipAssignment($organizationObject);
-
- // Send welcome email for new organization
- $this->sendOrganizationWelcomeEmail($organizationObject);
-
- // If organization is active, send activation email too
- $objectData = $organizationObject->getObject();
+ $this->addAdminGroupUsersToOrganization(organizationUuid: $organizationUuid);
+
+ // Handle ownership assignment for anonymous user registrations AFTER user creation.
+ $this->handleOwnershipAssignment(organizationObject: $organizationObject);
+
+ // Send welcome email for new organization.
+ $this->sendOrganizationWelcomeEmail(organizationObject: $organizationObject);
+
+ // If organization is active, send activation email too.
+ $objectData = $organizationObject->getObject();
$beoordeling = strtolower($objectData['beoordeling'] ?? '');
-
+
if ($beoordeling === 'actief') {
try {
$success = $this->_emailService->sendOrganizationActivationEmail($objectData);
- $this->_logger->info('Organization activation email sent', [
- 'objectId' => $organizationObject->getId(),
- 'success' => $success
- ]);
+ $this->_logger->info(
+ 'Organization activation email sent',
+ [
+ 'objectId' => $organizationObject->getId(),
+ 'success' => $success,
+ ]
+ );
} catch (\Exception $e) {
- $this->_logger->error('Failed to send organization activation email: ' . $e->getMessage(), [
- 'objectId' => $organizationObject->getId(),
- 'exception' => $e
- ]);
+ $this->_logger->error(
+ 'Failed to send organization activation email: '.$e->getMessage(),
+ [
+ 'objectId' => $organizationObject->getId(),
+ 'exception' => $e,
+ ]
+ );
}
}
-
- // Process nested contact persons and add their users to the organization entity
+
+ // Process nested contact persons and add their users to the organization entity.
$contactpersonen = $objectData['contactpersonen'] ?? [];
- if (!empty($contactpersonen)) {
- $this->_logger->info('SoftwareCatalogueService: Processing nested contact persons', [
- 'objectId' => $organizationObject->getId(),
- 'contactPersonCount' => count($contactpersonen)
- ]);
-
+ if (empty($contactpersonen) === false) {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Processing nested contact persons',
+ [
+ 'objectId' => $organizationObject->getId(),
+ 'contactPersonCount' => count($contactpersonen),
+ ]
+ );
+
$organizationUuid = $objectData['id'] ?? $organizationObject->getId();
- $objectService = $this->_getObjectService();
-
- if ($objectService) {
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+ $objectService = $this->getObjectService();
+
+ if (empty($objectService) === false) {
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
$voorzieningenConfig = $settingsService->getVoorzieningenConfig();
- $contactSchemaId = $voorzieningenConfig['contactpersoon_schema'] ?? null;
-
- if (!$contactSchemaId) {
+ $contactSchemaId = $voorzieningenConfig['contactpersoon_schema'] ?? null;
+
+ if ($contactSchemaId === null) {
$this->_logger->warning('SoftwareCatalogueService: Missing contactpersoon schema configuration');
return;
}
+
$organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
- $organisation = $organisationMapper->findByUuid($organizationUuid);
-
- if ($organisation) {
+ $organisation = $organisationMapper->findByUuid($organizationUuid);
+
+ if (empty($organisation) === false) {
$currentUsers = $organisation->getUsers() ?? [];
- $addedUsers = [];
-
+ $addedUsers = [];
+
foreach ($contactpersonen as $contactPersonId) {
try {
$contactPersonObject = $objectService->find($contactPersonId);
- $contactData = $contactPersonObject->getObject();
+ $contactData = $contactPersonObject->getObject();
$email = $contactData['email'] ?? null;
-
- if ($email && !in_array($email, $currentUsers)) {
+
+ if ($email !== false && in_array($email, $currentUsers) === false) {
$currentUsers[] = $email;
- $addedUsers[] = $email;
-
- $this->_logger->info('SoftwareCatalogueService: Added nested contact person user to organization', [
- 'objectId' => $organizationObject->getId(),
- 'contactPersonId' => $contactPersonId,
- 'username' => $email,
- 'organizationUuid' => $organizationUuid
- ]);
+ $addedUsers[] = $email;
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Added nested contact person user to organization',
+ [
+ 'objectId' => $organizationObject->getId(),
+ 'contactPersonId' => $contactPersonId,
+ 'username' => $email,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
}
} catch (\Exception $e) {
- $this->_logger->warning('SoftwareCatalogueService: Failed to process nested contact person', [
- 'objectId' => $organizationObject->getId(),
- 'contactPersonId' => $contactPersonId,
- 'error' => $e->getMessage()
- ]);
- }
- }
-
- if (!empty($addedUsers)) {
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Failed to process nested contact person',
+ [
+ 'objectId' => $organizationObject->getId(),
+ 'contactPersonId' => $contactPersonId,
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+ }//end foreach
+
+ if (empty($addedUsers) === false) {
$organisation->setUsers($currentUsers);
$organisationMapper->save($organisation);
-
- $this->_logger->info('SoftwareCatalogueService: Successfully updated organization with nested contact person users', [
- 'objectId' => $organizationObject->getId(),
- 'organizationUuid' => $organizationUuid,
- 'addedUsers' => $addedUsers,
- 'totalUsers' => count($currentUsers)
- ]);
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully updated organization with nested contact person users',
+ [
+ 'objectId' => $organizationObject->getId(),
+ 'organizationUuid' => $organizationUuid,
+ 'addedUsers' => $addedUsers,
+ 'totalUsers' => count($currentUsers),
+ ]
+ );
}
- }
- }
- }
-
- // Final synchronization: ensure all contact persons associated with this organization are in the users array
- // This handles cases where contact persons were created separately and not as nested objects
- $objectData = $organizationObject->getObject();
+ }//end if
+ }//end if
+ }//end if
+
+ // Final synchronization: ensure all contact persons associated with this organization are in the users array.
+ // This handles cases where contact persons were created separately and not as nested objects.
+ $objectData = $organizationObject->getObject();
$organizationUuid = $objectData['id'] ?? $organizationObject->getId();
- $this->syncContactPersonUsernamesWithOrganization($organizationUuid);
-
- $this->_logger->info('SoftwareCatalogueService: Completed final contact person synchronization for new organization', [
- 'objectId' => $organizationObject->getId(),
- 'organizationUuid' => $organizationUuid
- ]);
-
+ $this->syncContactPersonUsernamesWithOrganization(organizationUuid: $organizationUuid);
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Completed final contact person synchronization for new organization',
+ [
+ 'objectId' => $organizationObject->getId(),
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
} catch (\Exception $e) {
$this->_logger->error(
- 'SoftwareCatalogueService: Failed to handle new organization: ' . $e->getMessage(),
+ 'SoftwareCatalogueService: Failed to handle new organization: '.$e->getMessage(),
[
- 'objectId' => $organizationObject->getId(),
+ 'objectId' => $organizationObject->getId(),
'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString()
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
]
);
- }
- }
+ }//end try
+ }//end handleNewOrganization()
/**
* Handles organization updates - syncs with OpenRegister and manages user status based on organization status
*
* @param object $organizationObject The updated organization object
* @param object $oldOrganizationObject The previous organization object
- *
+ *
* @return void
*/
public function handleOrganizationUpdate(object $organizationObject, object $oldOrganizationObject): void
{
try {
- $this->_logger->info('SoftwareCatalogueService: Handling organization update', [
- 'objectId' => $organizationObject->getId()
- ]);
-
- $newData = $organizationObject->getObject();
- $oldData = $oldOrganizationObject->getObject();
-
- // Check both 'beoordeling' and 'status' fields (different schemas use different field names)
- $newBeoordeling = strtolower($newData['beoordeling'] ?? $newData['status'] ?? '');
- $oldBeoordeling = strtolower($oldData['beoordeling'] ?? $oldData['status'] ?? '');
-
- // Sync the organization with OpenRegister
- $syncResult = $this->syncOrganizationWithOpenRegister($organizationObject);
-
- if ($syncResult) {
- $this->_logger->info('SoftwareCatalogueService: Successfully synced organization with OpenRegister', [
- 'objectId' => $organizationObject->getId()
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Handling organization update',
+ [
+ 'objectId' => $organizationObject->getId(),
+ ]
+ );
+
+ $newData = $organizationObject->getObject();
+ $oldData = $oldOrganizationObject->getObject();
+
+ // Check both 'beoordeling' and 'status' fields (different schemas use different field names).
+ $newBeoordeling = strtolower($newData['beoordeling'] ?? $newData['status'] ?? '');
+ $oldBeoordeling = strtolower($oldData['beoordeling'] ?? $oldData['status'] ?? '');
+
+ // Sync the organization with OpenRegister.
+ $syncResult = $this->syncOrganizationWithOpenRegister(organizationObject: $organizationObject);
+
+ if (empty($syncResult) === false) {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully synced organization with OpenRegister',
+ [
+ 'objectId' => $organizationObject->getId(),
+ ]
+ );
} else {
- $this->_logger->warning('SoftwareCatalogueService: Failed to sync organization with OpenRegister', [
- 'objectId' => $organizationObject->getId()
- ]);
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Failed to sync organization with OpenRegister',
+ [
+ 'objectId' => $organizationObject->getId(),
+ ]
+ );
}
-
- // Add all admin group users to the organization (ensure they're always included)
+
+ // Add all admin group users to the organization (ensure they're always included).
$organizationUuid = $newData['id'] ?? $organizationObject->getId();
- $this->addAdminGroupUsersToOrganization($organizationUuid);
-
- // Check if organization status changed to active
+ $this->addAdminGroupUsersToOrganization(organizationUuid: $organizationUuid);
+
+ // Check if organization status changed to active.
if ($newBeoordeling === 'actief') {
$becameActive = ($oldBeoordeling !== 'actief');
-
+
+ if ($becameActive === true) {
+ $activeMessage = 'Organization became active, activating users';
+ } else {
+ $activeMessage = 'Organization is active';
+ }
+
$this->_logger->info(
- $becameActive ? 'Organization became active, activating users' : 'Organization is active',
+ $activeMessage,
[
'organizationId' => $organizationObject->getId(),
'oldBeoordeling' => $oldBeoordeling,
'newBeoordeling' => $newBeoordeling,
- 'becameActive' => $becameActive
+ 'becameActive' => $becameActive,
]
);
-
- if ($becameActive) {
+
+ if (empty($becameActive) === false) {
$organizationUuid = $newData['id'] ?? $organizationObject->getId();
-
- $this->_logger->info('SoftwareCatalogueService: Organization became active - creating users from contactpersonen', [
- 'organizationUuid' => $organizationUuid
- ]);
-
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Organization became active - creating users from contactpersonen',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+
// Process the organization to create users from contactpersonen.
- // This is crucial when an organization is activated for the first time
+ // This is crucial when an organization is activated for the first time.
// and contactpersonen were added before activation.
- $this->processOrganization($organizationObject);
-
- // Activate SoftwareCatalog-specific users in this organization
- $this->activateSoftwareCatalogUsersForOrganization($organizationUuid);
-
- // Send activation email
+ $this->processOrganization(organizationObject: $organizationObject);
+
+ // Activate SoftwareCatalog-specific users in this organization.
+ $this->activateSoftwareCatalogUsersForOrganization(organizationUuid: $organizationUuid);
+
+ // Send activation email.
try {
$success = $this->_emailService->sendOrganizationActivationEmail($newData);
- $this->_logger->info('Organization activation email sent', [
- 'objectId' => $organizationObject->getId(),
- 'success' => $success
- ]);
+ $this->_logger->info(
+ 'Organization activation email sent',
+ [
+ 'objectId' => $organizationObject->getId(),
+ 'success' => $success,
+ ]
+ );
} catch (\Exception $e) {
- $this->_logger->error('Failed to send organization activation email: ' . $e->getMessage(), [
- 'objectId' => $organizationObject->getId(),
- 'exception' => $e
- ]);
+ $this->_logger->error(
+ 'Failed to send organization activation email: '.$e->getMessage(),
+ [
+ 'objectId' => $organizationObject->getId(),
+ 'exception' => $e,
+ ]
+ );
}
- }
- }
-
- // Check if organization status changed to inactive
+ }//end if
+ }//end if
+
+ // Check if organization status changed to inactive.
if ($newBeoordeling === 'inactief' || $newBeoordeling === 'deactief') {
$becameInactive = ($oldBeoordeling === 'actief');
-
+
+ if ($becameInactive === true) {
+ $inactiveMessage = 'Organization became inactive, deactivating users';
+ } else {
+ $inactiveMessage = 'Organization is inactive';
+ }
+
$this->_logger->info(
- $becameInactive ? 'Organization became inactive, deactivating users' : 'Organization is inactive',
+ $inactiveMessage,
[
'organizationId' => $organizationObject->getId(),
'oldBeoordeling' => $oldBeoordeling,
'newBeoordeling' => $newBeoordeling,
- 'becameInactive' => $becameInactive
+ 'becameInactive' => $becameInactive,
]
);
-
- if ($becameInactive) {
- // Deactivate SoftwareCatalog-specific users in this organization
+
+ if (empty($becameInactive) === false) {
+ // Deactivate SoftwareCatalog-specific users in this organization.
$organizationUuid = $newData['id'] ?? $organizationObject->getId();
- $this->deactivateSoftwareCatalogUsersForOrganization($organizationUuid);
+ $this->deactivateSoftwareCatalogUsersForOrganization(organizationUuid: $organizationUuid);
}
- }
-
+ }//end if
} catch (\Exception $e) {
$this->_logger->error(
- 'SoftwareCatalogueService: Failed to handle organization update: ' . $e->getMessage(),
+ 'SoftwareCatalogueService: Failed to handle organization update: '.$e->getMessage(),
[
- 'objectId' => $organizationObject->getId(),
+ 'objectId' => $organizationObject->getId(),
'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString()
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
]
);
- }
- }
+ }//end try
+ }//end handleOrganizationUpdate()
/**
- * Activates contactpersonen users for an organization
- *
- * @deprecated This method is disabled to prevent organization duplication
- * @param string $organizationId The organization ID
- *
+ * Activates contactpersonen users for an organization.
+ *
+ * @param string $organizationId The organization ID.
+ *
* @return void
+ *
+ * @deprecated This method is disabled to prevent organization duplication.
*/
private function activateContactpersonenForOrganization(string $organizationId): void
{
- // DISABLED: Organization handling is disabled to prevent duplication
+ // DISABLED: Organization handling is disabled to prevent duplication.
$this->_logger->info(
'Organization contactpersonen activation is disabled to prevent duplication',
[
- 'organizationId' => $organizationId
+ 'organizationId' => $organizationId,
]
);
-
+
return;
-
- /*
- try {
- $this->_logger->info('Activating contactpersonen for organization', [
- 'organizationId' => $organizationId
- ]);
-
- // Get ObjectService to find contactpersonen
- $objectService = $this->_getObjectService();
- if (!$objectService) {
- $this->_logger->error('ObjectService not available');
- return;
- }
-
- // Get settings service to get schema IDs
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
- $voorzieningenConfig = $settingsService->getVoorzieningenConfig();
- $registerId = $voorzieningenConfig['register'] ?? null;
-
- // Find contactpersonen related to this organization
- $contactpersoonSchemaId = $voorzieningenConfig['contactpersoon_schema'] ?? null;
-
- // Skip if no proper configuration is available
- if (!$registerId || !$contactpersoonSchemaId) {
- $this->_logger->warning('SoftwareCatalogueService: Missing Voorzieningen configuration for contactpersonen', [
- 'organizationId' => $organizationId,
- 'registerId' => $registerId,
- 'contactpersoonSchemaId' => $contactpersoonSchemaId
- ]);
- return $organizationData;
- }
-
- $this->_logger->info('Schema IDs for contactpersonen search', [
- 'organizationId' => $organizationId,
- 'registerId' => $registerId,
- 'contactpersoonSchemaId' => $contactpersoonSchemaId
- ]);
-
- $activatedUsers = [];
-
- // Check contactpersoon objects (new data model)
- if ($contactpersoonSchemaId) {
- $contactpersoonObjects = $objectService->findAll(
- (int) $registerId,
- (int) $contactpersoonSchemaId,
- ['organisation' => $organizationId]
- );
-
- foreach ($contactpersoonObjects as $contactpersoonObject) {
- $contactData = $contactpersoonObject->getObject();
- $username = $contactData['username'] ?? '';
-
- if (!empty($username)) {
- $success = $this->_contactPersonHandler->setUserActive($username);
- if ($success) {
- $activatedUsers[] = $username;
- $this->_logger->info('Activated contactpersoon user', [
- 'username' => $username,
- 'organizationId' => $organizationId,
- 'contactpersoonId' => $contactpersoonObject->getId()
- ]);
- }
- }
- }
- }
-
- // Only use contactpersoon objects now - contactgegevens is deprecated
-
- $this->_logger->info('Completed contactpersonen activation for organization', [
- 'organizationId' => $organizationId,
- 'activatedUsers' => $activatedUsers,
- 'totalActivated' => count($activatedUsers)
- ]);
-
- } catch (\Exception $e) {
- $this->_logger->error(
- 'Failed to activate contactpersonen for organization: ' . $e->getMessage(),
- [
- 'organizationId' => $organizationId,
- 'exception' => $e
- ]
- );
- }
- */
- }
+
+ // Disabled: organization contactpersonen activation logic removed.
+ }//end activateContactpersonenForOrganization()
/**
- * Sends welcome email to organization
- *
- * @deprecated This method is disabled to prevent organization duplication
- * @param object $organizationObject The organization object
- *
+ * Sends welcome email to organization.
+ *
+ * @param object $organizationObject The organization object.
+ *
* @return void
+ *
+ * @deprecated This method is disabled to prevent organization duplication.
*/
public function sendOrganizationWelcomeEmail(object $organizationObject): void
{
- // DISABLED: Organization handling is disabled to prevent duplication
+ // DISABLED: Organization handling is disabled to prevent duplication.
$this->_logger->info(
'Organization welcome email sending is disabled to prevent duplication',
[
- 'organizationId' => $organizationObject->getId()
+ 'organizationId' => $organizationObject->getId(),
]
);
-
+
return;
-
- /*
- try {
- $this->_logger->info('Sending organization welcome email', [
- 'objectId' => $organizationObject->getId()
- ]);
-
- $objectData = $organizationObject->getObject();
-
- // Send organization registration email
- $success = $this->_emailService->sendOrganizationRegistrationEmail($objectData);
-
- if ($success) {
- $this->_logger->info('Organization welcome email sent successfully', [
- 'objectId' => $organizationObject->getId()
- ]);
- } else {
- $this->_logger->warning('Failed to send organization welcome email', [
- 'objectId' => $organizationObject->getId()
- ]);
- }
- } catch (\Exception $e) {
- $this->_logger->error('Exception sending organization welcome email: ' . $e->getMessage(), [
- 'objectId' => $organizationObject->getId(),
- 'exception' => $e
- ]);
- }
- */
- }
+
+ // Disabled: organization welcome email logic removed.
+ }//end sendOrganizationWelcomeEmail()
/**
* Handles new contact creation
*
* @param object $contactObject The contact object
- *
+ *
* @return void
*/
public function handleNewContact(object $contactObject): void
{
- // Delegate to contact person handler
+ // Delegate to contact person handler.
$this->_contactPersonHandler->handleNewContact($contactObject);
- }
+ }//end handleNewContact()
/**
* Creates user for contact if not exists
*
* @param object $contactObject The contact object
- *
+ *
* @return void
*/
public function createUserForContactIfNotExists(object $contactObject): void
{
- // Implementation for creating user from contact
- $this->_logger->info('Creating user for contact if not exists', [
- 'objectId' => $contactObject->getId()
- ]);
- }
+ // Implementation for creating user from contact.
+ $this->_logger->info(
+ 'Creating user for contact if not exists',
+ [
+ 'objectId' => $contactObject->getId(),
+ ]
+ );
+ }//end createUserForContactIfNotExists()
/**
* Handles new gebruiker creation
*
* @param object $gebruikerObject The gebruiker object
- *
+ *
* @return void
*/
public function handleNewGebruiker(object $gebruikerObject): void
{
- // Implementation for handling new gebruiker
- $this->_logger->info('Handling new gebruiker', [
- 'objectId' => $gebruikerObject->getId()
- ]);
- }
+ // Implementation for handling new gebruiker.
+ $this->_logger->info(
+ 'Handling new gebruiker',
+ [
+ 'objectId' => $gebruikerObject->getId(),
+ ]
+ );
+ }//end handleNewGebruiker()
/**
* Sends welcome email to gebruiker
*
* @param object $gebruikerObject The gebruiker object
- *
+ *
* @return void
*/
public function sendGebruikerWelcomeEmail(object $gebruikerObject): void
{
- // Implementation for sending gebruiker welcome email
- $this->_logger->info('Sending gebruiker welcome email', [
- 'objectId' => $gebruikerObject->getId()
- ]);
- }
+ // Implementation for sending gebruiker welcome email.
+ $this->_logger->info(
+ 'Sending gebruiker welcome email',
+ [
+ 'objectId' => $gebruikerObject->getId(),
+ ]
+ );
+ }//end sendGebruikerWelcomeEmail()
/**
* Handles contact update
*
* @param object $contactObject The contact object
- *
+ *
* @return void
*/
public function handleContactUpdate(object $contactObject): void
{
- // Delegate to contact person handler
+ // Delegate to contact person handler.
$this->_contactPersonHandler->handleContactUpdate($contactObject);
- }
+ }//end handleContactUpdate()
/**
* Handles gebruiker update
*
* @param object $gebruikerObject The new gebruiker object
* @param object $oldGebruikerObject The old gebruiker object
- *
+ *
* @return void
*/
public function handleGebruikerUpdate(object $gebruikerObject, object $oldGebruikerObject): void
{
- // Implementation for handling gebruiker updates
- $this->_logger->info('Handling gebruiker update', [
- 'objectId' => $gebruikerObject->getId()
- ]);
- }
+ // Implementation for handling gebruiker updates.
+ $this->_logger->info(
+ 'Handling gebruiker update',
+ [
+ 'objectId' => $gebruikerObject->getId(),
+ ]
+ );
+ }//end handleGebruikerUpdate()
/**
* Handles contact deletion
*
* @param object $contactObject The contact object
- *
+ *
* @return void
*/
public function handleContactDeletion(object $contactObject): void
{
- // Delegate to contact person handler
+ // Delegate to contact person handler.
$this->_contactPersonHandler->handleContactDeletion($contactObject);
- }
+ }//end handleContactDeletion()
/**
* Blocks user for gebruiker
*
* @param object $gebruikerObject The gebruiker object
- *
+ *
* @return void
*/
public function blockUserForGebruiker(object $gebruikerObject): void
{
- // Implementation for blocking user
- $this->_logger->info('Blocking user for gebruiker', [
- 'objectId' => $gebruikerObject->getId()
- ]);
- }
-
- /**
+ // Implementation for blocking user.
+ $this->_logger->info(
+ 'Blocking user for gebruiker',
+ [
+ 'objectId' => $gebruikerObject->getId(),
+ ]
+ );
+ }//end blockUserForGebruiker()
+
+ /**
* Temporarily blocks user for gebruiker
*
* @param object $gebruikerObject The gebruiker object
- *
+ *
* @return void
*/
public function temporarilyBlockUserForGebruiker(object $gebruikerObject): void
{
- // Implementation for temporarily blocking user
- $this->_logger->info('Temporarily blocking user for gebruiker', [
- 'objectId' => $gebruikerObject->getId()
- ]);
- }
+ // Implementation for temporarily blocking user.
+ $this->_logger->info(
+ 'Temporarily blocking user for gebruiker',
+ [
+ 'objectId' => $gebruikerObject->getId(),
+ ]
+ );
+ }//end temporarilyBlockUserForGebruiker()
/**
* Restores user access for gebruiker
*
* @param object $gebruikerObject The gebruiker object
- *
+ *
* @return void
*/
public function restoreUserAccessForGebruiker(object $gebruikerObject): void
{
- // Implementation for restoring user access
- $this->_logger->info('Restoring user access for gebruiker', [
- 'objectId' => $gebruikerObject->getId()
- ]);
- }
+ // Implementation for restoring user access.
+ $this->_logger->info(
+ 'Restoring user access for gebruiker',
+ [
+ 'objectId' => $gebruikerObject->getId(),
+ ]
+ );
+ }//end restoreUserAccessForGebruiker()
/**
* Syncs user with reverted contact
*
* @param object $contactObject The contact object
* @param mixed $revertPoint The revert point
- *
+ *
* @return void
*/
public function syncUserWithRevertedContact(object $contactObject, mixed $revertPoint): void
{
- // Implementation for syncing user with reverted contact
- $this->_logger->info('Syncing user with reverted contact', [
- 'objectId' => $contactObject->getId()
- ]);
- }
+ // Implementation for syncing user with reverted contact.
+ $this->_logger->info(
+ 'Syncing user with reverted contact',
+ [
+ 'objectId' => $contactObject->getId(),
+ ]
+ );
+ }//end syncUserWithRevertedContact()
/**
* Updates user from reverted gebruiker
*
* @param object $gebruikerObject The gebruiker object
* @param mixed $revertPoint The revert point
- *
+ *
* @return void
*/
public function updateUserFromRevertedGebruiker(object $gebruikerObject, mixed $revertPoint): void
{
- // Implementation for updating user from reverted gebruiker
- $this->_logger->info('Updating user from reverted gebruiker', [
- 'objectId' => $gebruikerObject->getId()
- ]);
- }
+ // Implementation for updating user from reverted gebruiker.
+ $this->_logger->info(
+ 'Updating user from reverted gebruiker',
+ [
+ 'objectId' => $gebruikerObject->getId(),
+ ]
+ );
+ }//end updateUserFromRevertedGebruiker()
/**
* Gets the list of generic user groups
@@ -994,19 +994,19 @@ public function updateUserFromRevertedGebruiker(object $gebruikerObject, mixed $
public function getGenericUserGroups(): array
{
return $this->_groupHandler->getGenericUserGroups();
- }
+ }//end getGenericUserGroups()
/**
* Sets the list of generic user groups
*
* @param array $groups Array of generic user groups
- *
+ *
* @return void
*/
public function setGenericUserGroups(array $groups): void
{
$this->_groupHandler->setGenericUserGroups($groups);
- }
+ }//end setGenericUserGroups()
/**
* Ensures all generic user groups exist
@@ -1016,365 +1016,440 @@ public function setGenericUserGroups(array $groups): void
public function ensureGenericUserGroupsExist(): array
{
return $this->_groupHandler->ensureGenericUserGroupsExist();
- }
+ }//end ensureGenericUserGroupsExist()
/**
* Gets organizational hierarchy information for a user
*
* @param string $username The username to get hierarchy for
- *
+ *
* @return array Array containing hierarchy information
*/
public function getUserHierarchy(string $username): array
{
return $this->_hierarchyHandler->getUserHierarchy($username);
- }
+ }//end getUserHierarchy()
/**
* Gets complete organizational structure
*
* @param string $organizationUuid The organization UUID
- *
+ *
* @return array Array containing organizational structure
*/
public function getOrganizationStructure(string $organizationUuid): array
{
return $this->_hierarchyHandler->getOrganizationStructure($organizationUuid);
- }
+ }//end getOrganizationStructure()
/**
* Handles contactpersoon updates, particularly role changes
*
* @param object $contactpersoonObject The updated contactpersoon object
* @param object $oldContactpersoonObject The previous contactpersoon object (optional)
- *
+ *
* @return void
*/
- public function handleContactpersoonUpdate(object $contactpersoonObject, object $oldContactpersoonObject = null): void
+ public function handleContactpersoonUpdate(object $contactpersoonObject, object $oldContactpersoonObject=null): void
{
$startTime = microtime(true);
-
+
try {
$objectId = $contactpersoonObject->getId();
- $this->_logger->info('SoftwareCatalogueService: Starting contactpersoon update handling', [
- 'objectId' => $objectId,
- 'hasOldObject' => $oldContactpersoonObject !== null,
- 'timestamp' => date('Y-m-d H:i:s')
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Starting contactpersoon update handling',
+ [
+ 'objectId' => $objectId,
+ 'hasOldObject' => $oldContactpersoonObject !== null,
+ 'timestamp' => date('Y-m-d H:i:s'),
+ ]
+ );
- // Get current and old data for comparison
+ // Get current and old data for comparison.
$newData = $contactpersoonObject->getObject();
- $oldData = $oldContactpersoonObject ? $oldContactpersoonObject->getObject() : [];
-
+ if ($oldContactpersoonObject !== null) {
+ $oldData = $oldContactpersoonObject->getObject();
+ } else {
+ $oldData = [];
+ }
+
$newRoles = $newData['roles'] ?? [];
$oldRoles = $oldData['roles'] ?? [];
-
- $this->_logger->debug('SoftwareCatalogueService: Comparing roles for contactpersoon update', [
- 'objectId' => $objectId,
- 'newRoles' => $newRoles,
- 'oldRoles' => $oldRoles,
- 'newRolesType' => gettype($newRoles),
- 'oldRolesType' => gettype($oldRoles)
- ]);
-
- // Ensure both are arrays
- if (!is_array($newRoles)) {
+
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Comparing roles for contactpersoon update',
+ [
+ 'objectId' => $objectId,
+ 'newRoles' => $newRoles,
+ 'oldRoles' => $oldRoles,
+ 'newRolesType' => gettype($newRoles),
+ 'oldRolesType' => gettype($oldRoles),
+ ]
+ );
+
+ // Ensure both are arrays.
+ if (is_array($newRoles) === false) {
$newRoles = [$newRoles];
- $this->_logger->debug('SoftwareCatalogueService: Converted newRoles to array', [
- 'objectId' => $objectId,
- 'newRoles' => $newRoles
- ]);
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Converted newRoles to array',
+ [
+ 'objectId' => $objectId,
+ 'newRoles' => $newRoles,
+ ]
+ );
}
- if (!is_array($oldRoles)) {
+
+ if (is_array($oldRoles) === false) {
$oldRoles = [$oldRoles];
- $this->_logger->debug('SoftwareCatalogueService: Converted oldRoles to array', [
- 'objectId' => $objectId,
- 'oldRoles' => $oldRoles
- ]);
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Converted oldRoles to array',
+ [
+ 'objectId' => $objectId,
+ 'oldRoles' => $oldRoles,
+ ]
+ );
}
-
- // For updates, we need to handle differently based on whether roles changed
+
+ // For updates, we need to handle differently based on whether roles changed.
if ($newRoles !== $oldRoles) {
- // Roles changed - use role-based group assignment instead of generic group assignment
+ // Roles changed - use role-based group assignment instead of generic group assignment.
$this->_logger->info(
'SoftwareCatalogueService: Roles changed for contactpersoon, using role-based group assignment',
[
'contactpersoonId' => $objectId,
- 'oldRoles' => $oldRoles,
- 'newRoles' => $newRoles,
- 'addedRoles' => array_diff($newRoles, $oldRoles),
- 'removedRoles' => array_diff($oldRoles, $newRoles)
+ 'oldRoles' => $oldRoles,
+ 'newRoles' => $newRoles,
+ 'addedRoles' => array_diff($newRoles, $oldRoles),
+ 'removedRoles' => array_diff($oldRoles, $newRoles),
]
);
-
- // Ensure user exists (but don't assign generic groups)
+
+ // Ensure user exists (but don't assign generic groups).
$username = $newData['username'] ?? '';
- if (empty($username)) {
- // Generate username and create user if needed
+ if (empty($username) === true) {
+ // Generate username and create user if needed.
$result = $this->_contactPersonHandler->processContactpersoon($contactpersoonObject, true);
- if ($result) {
+ if (empty($result) === false) {
$updatedData = $contactpersoonObject->getObject();
- $username = $updatedData['username'] ?? '';
+ $username = $updatedData['username'] ?? '';
}
}
-
- if (!empty($username)) {
+
+ if (empty($username) === false) {
$user = $this->_container->get(\OCP\IUserManager::class)->get($username);
- if ($user) {
- // Use new organization type-based logic instead of old role-based logic
+ if (empty($user) === false) {
+ // Use new organization type-based logic instead of old role-based logic.
$contactData = $contactpersoonObject->getObject();
$this->_contactPersonHandler->updateUserGroupsFromContactData($user, $contactData);
-
- $this->_logger->info('SoftwareCatalogueService: Organization type-based group updates completed', [
- 'username' => $username,
- 'objectId' => $objectId,
- 'newRoles' => $newRoles
- ]);
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Organization type-based group updates completed',
+ [
+ 'username' => $username,
+ 'objectId' => $objectId,
+ 'newRoles' => $newRoles,
+ ]
+ );
} else {
- $this->_logger->warning('SoftwareCatalogueService: User not found for role-based group updates', [
- 'username' => $username,
- 'objectId' => $objectId
- ]);
- }
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: User not found for role-based group updates',
+ [
+ 'username' => $username,
+ 'objectId' => $objectId,
+ ]
+ );
+ }//end if
} else {
- $this->_logger->warning('SoftwareCatalogueService: No username available for role-based group updates', [
- 'objectId' => $objectId,
- 'newData' => $newData
- ]);
- }
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: No username available for role-based group updates',
+ [
+ 'objectId' => $objectId,
+ 'newData' => $newData,
+ ]
+ );
+ }//end if
} else {
- // No role changes - use standard processing (assigns generic groups)
- $this->_logger->debug('SoftwareCatalogueService: No role changes, using standard contactpersoon processing', [
- 'objectId' => $objectId,
- 'roles' => $newRoles
- ]);
-
- $result = $this->processContactpersoon($contactpersoonObject, true);
-
- $this->_logger->info('SoftwareCatalogueService: Standard contactpersoon processing completed', [
- 'objectId' => $objectId,
- 'result' => $result,
- 'processingTime' => round((microtime(true) - $startTime) * 1000, 2) . 'ms'
- ]);
- }
-
- $this->_logger->info('SoftwareCatalogueService: Contactpersoon update handling completed', [
- 'objectId' => $objectId,
- 'totalProcessingTime' => round((microtime(true) - $startTime) * 1000, 2) . 'ms'
- ]);
-
+ // No role changes - use standard processing (assigns generic groups).
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: No role changes, using standard contactpersoon processing',
+ [
+ 'objectId' => $objectId,
+ 'roles' => $newRoles,
+ ]
+ );
+
+ $result = $this->processContactpersoon(contactpersoonObject: $contactpersoonObject, isUpdate: true);
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Standard contactpersoon processing completed',
+ [
+ 'objectId' => $objectId,
+ 'result' => $result,
+ 'processingTime' => round((microtime(true) - $startTime) * 1000, 2).'ms',
+ ]
+ );
+ }//end if
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Contactpersoon update handling completed',
+ [
+ 'objectId' => $objectId,
+ 'totalProcessingTime' => round((microtime(true) - $startTime) * 1000, 2).'ms',
+ ]
+ );
} catch (\Exception $e) {
$this->_logger->error(
- 'SoftwareCatalogueService: Failed to handle contactpersoon update: ' . $e->getMessage(),
+ 'SoftwareCatalogueService: Failed to handle contactpersoon update: '.$e->getMessage(),
[
- 'objectId' => $contactpersoonObject->getId(),
- 'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString(),
- 'processingTime' => round((microtime(true) - $startTime) * 1000, 2) . 'ms'
+ 'objectId' => $contactpersoonObject->getId(),
+ 'exception' => $e->getMessage(),
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
+ 'processingTime' => round((microtime(true) - $startTime) * 1000, 2).'ms',
]
);
- }
- }
-
+ }//end try
+ }//end handleContactpersoonUpdate()
/**
* Handles organization deletion - deactivates all users in the organization
*
* @param object $organizationObject The organization object being deleted
- *
+ *
* @return void
*/
public function handleOrganizationDeletion(object $organizationObject): void
{
try {
- $this->_logger->info('SoftwareCatalogueService: Handling organization deletion', [
- 'objectId' => $organizationObject->getId()
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Handling organization deletion',
+ [
+ 'objectId' => $organizationObject->getId(),
+ ]
+ );
- $objectData = $organizationObject->getObject();
+ $objectData = $organizationObject->getObject();
$organizationUuid = $objectData['id'] ?? $organizationObject->getId();
- // Deactivate all users in this organization
- $this->deactivateUsersForOrganization($organizationUuid);
+ // Deactivate all users in this organization.
+ $this->deactivateUsersForOrganization(organizationUuid: $organizationUuid);
$this->_logger->info(
'SoftwareCatalogueService: Successfully handled organization deletion',
[
'organizationId' => $organizationUuid,
- 'timestamp' => date('Y-m-d H:i:s')
+ 'timestamp' => date('Y-m-d H:i:s'),
]
);
-
} catch (\Exception $e) {
$this->_logger->error(
- 'SoftwareCatalogueService: Failed to handle organization deletion: ' . $e->getMessage(),
+ 'SoftwareCatalogueService: Failed to handle organization deletion: '.$e->getMessage(),
[
- 'objectId' => $organizationObject->getId(),
+ 'objectId' => $organizationObject->getId(),
'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString()
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
]
);
- }
- }
+ }//end try
+ }//end handleOrganizationDeletion()
/**
* Syncs organization data with OpenRegister
*
* @param object $organizationObject The organization object to sync
- *
+ *
* @return bool True if sync was successful
*/
public function syncOrganizationWithOpenRegister(object $organizationObject): bool
{
try {
- $this->_logger->info('SoftwareCatalogueService: SYNC_STEP_1 - Starting syncOrganizationWithOpenRegister', [
- 'objectId' => $organizationObject->getId(),
- 'objectClass' => get_class($organizationObject)
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: SYNC_STEP_1 - Starting syncOrganizationWithOpenRegister',
+ [
+ 'objectId' => $organizationObject->getId(),
+ 'objectClass' => get_class($organizationObject),
+ ]
+ );
- $objectData = $organizationObject->getObject();
+ $objectData = $organizationObject->getObject();
$organizationUuid = $objectData['id'] ?? $organizationObject->getId();
-
- $this->_logger->info('SoftwareCatalogueService: SYNC_STEP_2 - Extracted organization data', [
- 'organizationUuid' => $organizationUuid,
- 'objectDataKeys' => array_keys($objectData),
- 'hasId' => isset($objectData['id'])
- ]);
-
- // Get OpenRegister OrganisationService for proper organization entity management
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: SYNC_STEP_2 - Extracted organization data',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'objectDataKeys' => array_keys($objectData),
+ 'hasId' => isset($objectData['id']) === true,
+ ]
+ );
+
+ // Get OpenRegister OrganisationService for proper organization entity management.
$this->_logger->info('SoftwareCatalogueService: SYNC_STEP_3 - Getting OrganisationService');
- $organisationService = $this->_getOrganisationService();
- if (!$organisationService) {
+ $organisationService = $this->getOrganisationService();
+ if ($organisationService === null) {
$this->_logger->error('SoftwareCatalogueService: SYNC_STEP_3 - OpenRegister OrganisationService not available');
return false;
}
- $this->_logger->info('SoftwareCatalogueService: SYNC_STEP_3 - OrganisationService retrieved', [
- 'serviceClass' => get_class($organisationService)
- ]);
- $this->_logger->info('SoftwareCatalogueService: SYNC_STEP_4 - OpenRegister configuration', [
- 'organizationUuid' => $organizationUuid,
- 'organizationName' => $objectData['naam'] ?? 'Unknown'
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: SYNC_STEP_3 - OrganisationService retrieved',
+ [
+ 'serviceClass' => get_class($organisationService),
+ ]
+ );
- // Check if organization already exists in OpenRegister
+ $this->_logger->info(
+ 'SoftwareCatalogueService: SYNC_STEP_4 - OpenRegister configuration',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'organizationName' => $objectData['naam'] ?? 'Unknown',
+ ]
+ );
+
+ // Check if organization already exists in OpenRegister.
$this->_logger->info('SoftwareCatalogueService: SYNC_STEP_5 - Checking if organization exists in OpenRegister');
try {
$this->_logger->info('SoftwareCatalogueService: SYNC_STEP_5A - Getting OrganisationMapper for lookup');
$organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
- $this->_logger->info('SoftwareCatalogueService: SYNC_STEP_5B - Calling findByUuid', [
- 'uuid' => $organizationUuid
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: SYNC_STEP_5B - Calling findByUuid',
+ [
+ 'uuid' => $organizationUuid,
+ ]
+ );
$existingOrganisation = $organisationMapper->findByUuid($organizationUuid);
-
- // Organization exists - update it
- $this->_logger->info('SoftwareCatalogueService: SYNC_STEP_6 - Organization exists in OpenRegister, updating', [
- 'organizationId' => $organizationUuid,
- 'existingOrganisationClass' => get_class($existingOrganisation)
- ]);
- // Map status from SoftwareCatalog to OpenRegister
+ // Organization exists - update it.
+ $this->_logger->info(
+ 'SoftwareCatalogueService: SYNC_STEP_6 - Organization exists in OpenRegister, updating',
+ [
+ 'organizationId' => $organizationUuid,
+ 'existingOrganisationClass' => get_class($existingOrganisation),
+ ]
+ );
+
+ // Map status from SoftwareCatalog to OpenRegister.
$this->_logger->info('SoftwareCatalogueService: SYNC_STEP_7 - Mapping organization data');
- $mappedData = $this->mapOrganizationDataForOpenRegister($objectData);
-
- // Update the organization using OrganisationService
- $updatedOrganisation = $this->updateOrganisationInOpenRegister($organisationService, $existingOrganisation, $mappedData);
+ $mappedData = $this->mapOrganizationDataForOpenRegister(objectData: $objectData);
- $this->_logger->info('SoftwareCatalogueService: Successfully updated organization in OpenRegister', [
- 'organizationId' => $organizationUuid,
- 'openRegisterId' => $updatedOrganisation->getUuid()
- ]);
+ // Update the organization using OrganisationService.
+ $updatedOrganisation = $this->updateOrganisationInOpenRegister(
+ organisationService: $organisationService,
+ existingOrganisation: $existingOrganisation,
+ mappedData: $mappedData
+ );
- return true;
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully updated organization in OpenRegister',
+ [
+ 'organizationId' => $organizationUuid,
+ 'openRegisterId' => $updatedOrganisation->getUuid(),
+ ]
+ );
+ return true;
} catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
- // Organization doesn't exist - create it
- $this->_logger->info('SoftwareCatalogueService: SYNC_STEP_8 - Organization not found in OpenRegister, creating', [
- 'organizationId' => $organizationUuid,
- 'exception' => $e->getMessage()
- ]);
+ // Organization doesn't exist - create it.
+ $this->_logger->info(
+ 'SoftwareCatalogueService: SYNC_STEP_8 - Organization not found in OpenRegister, creating',
+ [
+ 'organizationId' => $organizationUuid,
+ 'exception' => $e->getMessage(),
+ ]
+ );
- // Map status from SoftwareCatalog to OpenRegister
+ // Map status from SoftwareCatalog to OpenRegister.
$this->_logger->info('SoftwareCatalogueService: SYNC_STEP_9 - Mapping organization data for creation');
- $mappedData = $this->mapOrganizationDataForOpenRegister($objectData);
-
- // Create the organization using OrganisationService
+ $mappedData = $this->mapOrganizationDataForOpenRegister(objectData: $objectData);
+
+ // Create the organization using OrganisationService.
$this->_logger->info('SoftwareCatalogueService: SYNC_STEP_10 - Calling createOrganisationInOpenRegister');
- $createdOrganisation = $this->createOrganisationInOpenRegisterInternal($organisationService, $mappedData, $organizationUuid);
+ $createdOrganisation = $this->createOrganisationInOpenRegisterInternal(
+ organisationService: $organisationService,
+ mappedData: $mappedData,
+ organizationUuid: $organizationUuid
+ );
- $this->_logger->info('SoftwareCatalogueService: SYNC_STEP_11 - Successfully created organization in OpenRegister', [
- 'organizationId' => $organizationUuid,
- 'openRegisterId' => $createdOrganisation->getUuid(),
- 'createdOrganisationClass' => get_class($createdOrganisation)
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: SYNC_STEP_11 - Successfully created organization in OpenRegister',
+ [
+ 'organizationId' => $organizationUuid,
+ 'openRegisterId' => $createdOrganisation->getUuid(),
+ 'createdOrganisationClass' => get_class($createdOrganisation),
+ ]
+ );
return true;
- }
-
+ }//end try
} catch (\Exception $e) {
$this->_logger->error(
- 'SoftwareCatalogueService: Failed to sync organization with OpenRegister: ' . $e->getMessage(),
+ 'SoftwareCatalogueService: Failed to sync organization with OpenRegister: '.$e->getMessage(),
[
- 'objectId' => $organizationObject->getId(),
+ 'objectId' => $organizationObject->getId(),
'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString()
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
]
);
return false;
- }
- }
+ }//end try
+ }//end syncOrganizationWithOpenRegister()
/**
* Public wrapper for creating organization in OpenRegister (used by background job)
*
* @param array $objectData The organization object data
- *
+ *
* @return object|null The created organisation entity or null on failure
*/
public function createOrganisationInOpenRegister(array $objectData): ?object
{
try {
$organizationUuid = $objectData['id'] ?? null;
- if (!$organizationUuid) {
+ if ($organizationUuid === null) {
$this->_logger->error('SoftwareCatalogueService: No organization UUID provided for creation');
return null;
}
-
- // Map the data
+
+ // Map the data.
$mappedData = [
- 'naam' => $objectData['naam'] ?? 'Unknown',
- 'type' => $objectData['type'] ?? '',
- 'website' => $objectData['website'] ?? '',
- 'active' => $this->mapStatus($objectData['beoordeling'] ?? 'actief'),
+ 'naam' => $objectData['naam'] ?? 'Unknown',
+ 'type' => $objectData['type'] ?? '',
+ 'website' => $objectData['website'] ?? '',
+ 'active' => $this->mapStatus(status: $objectData['beoordeling'] ?? 'actief'),
'contactpersonen' => $objectData['contactpersonen'] ?? [],
- 'deelnemers' => $objectData['deelnemers'] ?? []
+ 'deelnemers' => $objectData['deelnemers'] ?? [],
];
-
- // Get organisation service
+
+ // Get organisation service.
$organisationService = $this->_container->get('OCA\OpenRegister\Service\OrganisationService');
-
- return $this->createOrganisationInOpenRegisterInternal($organisationService, $mappedData, $organizationUuid);
-
+
+ return $this->createOrganisationInOpenRegisterInternal(
+ organisationService: $organisationService,
+ mappedData: $mappedData,
+ organizationUuid: $organizationUuid
+ );
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: Error in public createOrganisationInOpenRegister', [
- 'error' => $e->getMessage(),
- 'objectData' => $objectData
- ]);
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Error in public createOrganisationInOpenRegister',
+ [
+ 'error' => $e->getMessage(),
+ 'objectData' => $objectData,
+ ]
+ );
return null;
- }
- }
+ }//end try
+ }//end createOrganisationInOpenRegister()
/**
* Map status from Software Catalog to OpenRegister format
*
* @param string $status The status from Software Catalog
- *
+ *
* @return bool The mapped active status for OpenRegister
*/
private function mapStatus(string $status): bool
@@ -1385,17 +1460,18 @@ private function mapStatus(string $status): bool
case 'inactief':
return false;
default:
- return true; // Default to active
+ return true;
+ // Default to active.
}
- }
+ }//end mapStatus()
/**
* Creates an organization in OpenRegister using OrganisationService
*
* @param \OCA\OpenRegister\Service\OrganisationService $organisationService The OpenRegister organisation service
- * @param array $mappedData The mapped organization data
- * @param string $organizationUuid The organization UUID to use
- *
+ * @param array $mappedData The mapped organization data
+ * @param string $organizationUuid The organization UUID to use
+ *
* @return \OCA\OpenRegister\Db\Organisation The created organization
*/
private function createOrganisationInOpenRegisterInternal(
@@ -1403,197 +1479,263 @@ private function createOrganisationInOpenRegisterInternal(
array $mappedData,
string $organizationUuid
): \OCA\OpenRegister\Db\Organisation {
- $this->_logger->info('SoftwareCatalogueService: STEP 1 - Starting createOrganisationInOpenRegister', [
- 'organizationUuid' => $organizationUuid,
- 'name' => $mappedData['naam'] ?? 'Unknown',
- 'mappedDataKeys' => array_keys($mappedData)
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 1 - Starting createOrganisationInOpenRegister',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'name' => $mappedData['naam'] ?? 'Unknown',
+ 'mappedDataKeys' => array_keys($mappedData),
+ ]
+ );
- // Check if we're in an anonymous context (no logged-in user)
+ // Check if we're in an anonymous context (no logged-in user).
$userSession = \OC::$server->getUserSession();
$currentUser = $userSession->getUser();
-
- $this->_logger->info('SoftwareCatalogueService: STEP 2 - Checking user context', [
- 'hasUserSession' => $userSession !== null,
- 'currentUser' => $currentUser ? $currentUser->getUID() : 'null',
- 'isAnonymous' => $currentUser === null
- ]);
-
- if (!$currentUser) {
- $this->_logger->info('SoftwareCatalogueService: STEP 3A - Anonymous path: No user logged in, creating organization directly via mapper', [
- 'organizationUuid' => $organizationUuid
- ]);
-
- // Keep the original UUID format - no conversion needed
- $this->_logger->info('SoftwareCatalogueService: STEP 3B - Using original UUID format for OpenRegister (anonymous)', [
- 'organizationUuid' => $organizationUuid
- ]);
-
- // Create organization directly via mapper to avoid user context requirements
+
+ if ($currentUser !== null) {
+ $currentUserValue = $currentUser->getUID();
+ } else {
+ $currentUserValue = 'null';
+ }
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 2 - Checking user context',
+ [
+ 'hasUserSession' => $userSession !== null,
+ 'currentUser' => $currentUserValue,
+ 'isAnonymous' => $currentUser === null,
+ ]
+ );
+
+ if ($currentUser === null) {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 3A - Anonymous path: No user logged in, creating organization directly via mapper',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+
+ // Keep the original UUID format - no conversion needed.
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 3B - Using original UUID format for OpenRegister (anonymous)',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+
+ // Create organization directly via mapper to avoid user context requirements.
$this->_logger->info('SoftwareCatalogueService: STEP 3C - Getting OrganisationMapper from container');
$organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
- $this->_logger->info('SoftwareCatalogueService: STEP 3D - OrganisationMapper retrieved', [
- 'mapperClass' => get_class($organisationMapper)
- ]);
-
- // Create a new Organisation entity
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 3D - OrganisationMapper retrieved',
+ [
+ 'mapperClass' => get_class($organisationMapper),
+ ]
+ );
+
+ // Create a new Organisation entity.
$this->_logger->info('SoftwareCatalogueService: STEP 3E - Creating new Organisation entity');
$organisation = new \OCA\OpenRegister\Db\Organisation();
-
- $this->_logger->info('SoftwareCatalogueService: STEP 3F - Setting organisation properties', [
- 'name' => $mappedData['naam'] ?? 'Unknown Organization',
- 'description' => $mappedData['website'] ?? '',
- 'uuid' => $organizationUuid
- ]);
-
- // Collect all contact person usernames for this organization
- $contactPersonUsernames = $this->collectContactPersonUsernames($organizationUuid, $mappedData);
-
- // Start with admin user and add all contact person usernames
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 3F - Setting organisation properties',
+ [
+ 'name' => $mappedData['naam'] ?? 'Unknown Organization',
+ 'description' => $mappedData['website'] ?? '',
+ 'uuid' => $organizationUuid,
+ ]
+ );
+
+ // Collect all contact person usernames for this organization.
+ $contactPersonUsernames = $this->collectContactPersonUsernames(organizationUuid: $organizationUuid, objectData: $mappedData);
+
+ // Start with admin user and add all contact person usernames.
$allUsernames = array_merge(['admin'], $contactPersonUsernames);
$allUsernames = array_unique($allUsernames);
-
- $this->_logger->info('SoftwareCatalogueService: STEP 3F_2 - Collected usernames for organization', [
- 'organizationUuid' => $organizationUuid,
- 'totalUsernames' => count($allUsernames),
- 'usernames' => $allUsernames
- ]);
-
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 3F_2 - Collected usernames for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'totalUsernames' => count($allUsernames),
+ 'usernames' => $allUsernames,
+ ]
+ );
+
$organisation->setName($mappedData['naam'] ?? 'Unknown Organization');
- $organisation->setDescription($mappedData['website'] ?? ''); // Use website as description
+ $organisation->setDescription($mappedData['website'] ?? '');
+ // Use website as description.
$organisation->setUuid($organizationUuid);
$organisation->setUsers($allUsernames);
- $organisation->setOwner('admin'); // Set admin as owner for anonymous registrations
- $organisation->setActive($mappedData['active'] ?? true); // Set active status based on organization beoordeling
-
- // Debug: Check if UUID was set correctly
- $this->_logger->info('SoftwareCatalogueService: STEP 3G - Debug - UUID before save', [
- 'setUuid' => $organizationUuid,
- 'getUuid' => $organisation->getUuid(),
- 'uuidMatches' => $organisation->getUuid() === $organizationUuid,
- 'organisationClass' => get_class($organisation)
- ]);
-
- // Save the organization
+ $organisation->setOwner('admin');
+ // Set admin as owner for anonymous registrations.
+ $organisation->setActive($mappedData['active'] ?? true);
+ // Set active status based on organization beoordeling.
+ // Debug: Check if UUID was set correctly.
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 3G - Debug - UUID before save',
+ [
+ 'setUuid' => $organizationUuid,
+ 'getUuid' => $organisation->getUuid(),
+ 'uuidMatches' => $organisation->getUuid() === $organizationUuid,
+ 'organisationClass' => get_class($organisation),
+ ]
+ );
+
+ // Save the organization.
$this->_logger->info('SoftwareCatalogueService: STEP 3H - Calling organisationMapper->save()');
try {
$savedOrganisation = $organisationMapper->save($organisation);
$this->_logger->info('SoftwareCatalogueService: STEP 3I - organisationMapper->save() completed successfully');
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: STEP 3I - organisationMapper->save() failed', [
- 'error' => $e->getMessage(),
- 'errorClass' => get_class($e),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->_logger->error(
+ 'SoftwareCatalogueService: STEP 3I - organisationMapper->save() failed',
+ [
+ 'error' => $e->getMessage(),
+ 'errorClass' => get_class($e),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
throw $e;
}
-
- $this->_logger->info('SoftwareCatalogueService: Successfully created organization in OpenRegister via mapper', [
- 'organizationUuid' => $organizationUuid,
- 'openRegisterId' => $savedOrganisation->getUuid(),
- 'savedUuid' => $savedOrganisation->getUuid(),
- 'expectedUuid' => $organizationUuid
- ]);
-
- // Verify the UUID was preserved
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully created organization in OpenRegister via mapper',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'openRegisterId' => $savedOrganisation->getUuid(),
+ 'savedUuid' => $savedOrganisation->getUuid(),
+ 'expectedUuid' => $organizationUuid,
+ ]
+ );
+
+ // Verify the UUID was preserved.
if ($savedOrganisation->getUuid() !== $organizationUuid) {
- $this->_logger->warning('SoftwareCatalogueService: UUID mismatch after saving organization', [
- 'expectedUuid' => $organizationUuid,
- 'actualUuid' => $savedOrganisation->getUuid()
- ]);
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: UUID mismatch after saving organization',
+ [
+ 'expectedUuid' => $organizationUuid,
+ 'actualUuid' => $savedOrganisation->getUuid(),
+ ]
+ );
}
-
+
return $savedOrganisation;
} else {
- $this->_logger->info('SoftwareCatalogueService: STEP 4A - Authenticated path: User logged in, creating organization via mapper', [
- 'organizationUuid' => $organizationUuid,
- 'currentUser' => $currentUser->getUID()
- ]);
-
- // Keep the original UUID format - no conversion needed
- $this->_logger->info('SoftwareCatalogueService: STEP 4B - Using original UUID format for OpenRegister', [
- 'organizationUuid' => $organizationUuid
- ]);
-
- // Create organization directly via mapper to avoid service issues
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 4A - Authenticated path: User logged in, creating organization via mapper',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'currentUser' => $currentUser->getUID(),
+ ]
+ );
+
+ // Keep the original UUID format - no conversion needed.
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 4B - Using original UUID format for OpenRegister',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+
+ // Create organization directly via mapper to avoid service issues.
$this->_logger->info('SoftwareCatalogueService: STEP 4C - Getting OrganisationMapper from container');
$organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
- $this->_logger->info('SoftwareCatalogueService: STEP 4D - OrganisationMapper retrieved', [
- 'mapperClass' => get_class($organisationMapper)
- ]);
-
- // Debug: Check UUID before creating
- // Collect all contact person usernames for this organization
- $contactPersonUsernames = $this->collectContactPersonUsernames($organizationUuid, $mappedData);
-
- // Start with current user and add all contact person usernames
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 4D - OrganisationMapper retrieved',
+ [
+ 'mapperClass' => get_class($organisationMapper),
+ ]
+ );
+
+ // Debug: Check UUID before creating.
+ // Collect all contact person usernames for this organization.
+ $contactPersonUsernames = $this->collectContactPersonUsernames(organizationUuid: $organizationUuid, objectData: $mappedData);
+
+ // Start with current user and add all contact person usernames.
$allUsernames = array_merge([$currentUser->getUID()], $contactPersonUsernames);
$allUsernames = array_unique($allUsernames);
-
- $this->_logger->info('SoftwareCatalogueService: STEP 4E - Debug - UUID before createWithUuid', [
- 'organizationUuid' => $organizationUuid,
- 'uuidLength' => strlen($organizationUuid),
- 'uuidIsEmpty' => empty($organizationUuid),
- 'name' => $mappedData['naam'] ?? 'Unknown Organization',
- 'description' => $mappedData['website'] ?? '',
- 'owner' => $currentUser->getUID(),
- 'users' => $allUsernames,
- 'contactPersonUsernames' => $contactPersonUsernames
- ]);
-
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 4E - Debug - UUID before createWithUuid',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'uuidLength' => strlen($organizationUuid),
+ 'uuidIsEmpty' => empty($organizationUuid) === true,
+ 'name' => $mappedData['naam'] ?? 'Unknown Organization',
+ 'description' => $mappedData['website'] ?? '',
+ 'owner' => $currentUser->getUID(),
+ 'users' => $allUsernames,
+ 'contactPersonUsernames' => $contactPersonUsernames,
+ ]
+ );
+
$this->_logger->info('SoftwareCatalogueService: STEP 4F - Calling organisationMapper->createWithUuid()');
try {
- // Debug: Log the exact parameters being passed
- $this->_logger->info('SoftwareCatalogueService: STEP 4F_DEBUG - Parameters for createWithUuid', [
- 'name' => $mappedData['naam'] ?? 'Unknown Organization',
- 'description' => $mappedData['website'] ?? '',
- 'uuid' => $organizationUuid,
- 'owner' => $currentUser->getUID(),
- 'users' => $allUsernames,
- 'isDefault' => false,
- 'uuidLength' => strlen($organizationUuid),
- 'uuidIsEmpty' => empty($organizationUuid)
- ]);
-
+ // Debug: Log the exact parameters being passed.
+ $this->_logger->info(
+ 'SoftwareCatalogueService: STEP 4F_DEBUG - Parameters for createWithUuid',
+ [
+ 'name' => $mappedData['naam'] ?? 'Unknown Organization',
+ 'description' => $mappedData['website'] ?? '',
+ 'uuid' => $organizationUuid,
+ 'owner' => $currentUser->getUID(),
+ 'users' => $allUsernames,
+ 'isDefault' => false,
+ 'uuidLength' => strlen($organizationUuid),
+ 'uuidIsEmpty' => empty($organizationUuid) === true,
+ ]
+ );
+
$organisation = $organisationMapper->createWithUuid(
$mappedData['naam'] ?? 'Unknown Organization',
- $mappedData['website'] ?? '', // Use website as description
- $organizationUuid, // Pass the original UUID
- $currentUser->getUID(), // Set current user as owner
- $allUsernames, // Add all users including contact persons
- false // Not default
+ $mappedData['website'] ?? '',
+ // Use website as description.
+ $organizationUuid,
+ // Pass the original UUID.
+ $currentUser->getUID(),
+ // Set current user as owner.
+ $allUsernames,
+ // Add all users including contact persons.
+ false
+ // Not default.
);
$this->_logger->info('SoftwareCatalogueService: STEP 4G - organisationMapper->createWithUuid() completed successfully');
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: STEP 4G - organisationMapper->createWithUuid() failed', [
- 'error' => $e->getMessage(),
- 'errorClass' => get_class($e),
- 'trace' => $e->getTraceAsString()
- ]);
+ $this->_logger->error(
+ 'SoftwareCatalogueService: STEP 4G - organisationMapper->createWithUuid() failed',
+ [
+ 'error' => $e->getMessage(),
+ 'errorClass' => get_class($e),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
throw $e;
- }
-
- // Note: OpenRegister Organisation entity doesn't have status or type fields
- // These are managed in the SoftwareCatalog object, not in the OpenRegister organisation
+ }//end try
- $this->_logger->info('SoftwareCatalogueService: Successfully created organization in OpenRegister via service', [
- 'organizationUuid' => $organizationUuid,
- 'openRegisterId' => $organisation->getUuid(),
- 'savedUuid' => $organisation->getUuid(),
- 'expectedUuid' => $organizationUuid
- ]);
+ // Note: OpenRegister Organisation entity doesn't have status or type fields.
+ // These are managed in the SoftwareCatalog object, not in the OpenRegister organisation.
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully created organization in OpenRegister via service',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'openRegisterId' => $organisation->getUuid(),
+ 'savedUuid' => $organisation->getUuid(),
+ 'expectedUuid' => $organizationUuid,
+ ]
+ );
return $organisation;
- }
- }
+ }//end if
+ }//end createOrganisationInOpenRegisterInternal()
/**
* Updates an organization in OpenRegister using OrganisationService
*
- * @param \OCA\OpenRegister\Service\OrganisationService $organisationService The OpenRegister organisation service
- * @param \OCA\OpenRegister\Db\Organisation $existingOrganisation The existing organization
- * @param array $mappedData The mapped organization data
- *
+ * @param \OCA\OpenRegister\Service\OrganisationService $organisationService The OpenRegister organisation service
+ * @param \OCA\OpenRegister\Db\Organisation $existingOrganisation The existing organization
+ * @param array $mappedData The mapped organization data
+ *
* @return \OCA\OpenRegister\Db\Organisation The updated organization
*/
private function updateOrganisationInOpenRegister(
@@ -1601,232 +1743,277 @@ private function updateOrganisationInOpenRegister(
\OCA\OpenRegister\Db\Organisation $existingOrganisation,
array $mappedData
): \OCA\OpenRegister\Db\Organisation {
- $this->_logger->info('SoftwareCatalogueService: Updating organization in OpenRegister', [
- 'organizationUuid' => $existingOrganisation->getUuid(),
- 'name' => $mappedData['name'] ?? 'Unknown'
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Updating organization in OpenRegister',
+ [
+ 'organizationUuid' => $existingOrganisation->getUuid(),
+ 'name' => $mappedData['name'] ?? 'Unknown',
+ ]
+ );
- // Update organization fields (only those that exist on the Organisation entity)
- if (isset($mappedData['name'])) {
+ // Update organization fields (only those that exist on the Organisation entity).
+ if (isset($mappedData['name']) === true) {
$existingOrganisation->setName($mappedData['name']);
}
-
- if (isset($mappedData['description'])) {
+
+ if (isset($mappedData['description']) === true) {
$existingOrganisation->setDescription($mappedData['description']);
}
-
- // Note: OpenRegister Organisation entity doesn't have status or type fields
- // These are managed in the SoftwareCatalog object, not in the OpenRegister organisation
- // Save the updated organization
- $organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
+ // Note: OpenRegister Organisation entity doesn't have status or type fields.
+ // These are managed in the SoftwareCatalog object, not in the OpenRegister organisation.
+ // Save the updated organization.
+ $organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
$updatedOrganisation = $organisationMapper->save($existingOrganisation);
- $this->_logger->info('SoftwareCatalogueService: Successfully updated organization in OpenRegister', [
- 'organizationUuid' => $existingOrganisation->getUuid(),
- 'openRegisterId' => $updatedOrganisation->getUuid()
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully updated organization in OpenRegister',
+ [
+ 'organizationUuid' => $existingOrganisation->getUuid(),
+ 'openRegisterId' => $updatedOrganisation->getUuid(),
+ ]
+ );
return $updatedOrganisation;
- }
+ }//end updateOrganisationInOpenRegister()
/**
- * Collects all contact person usernames associated with an organization
- *
- * @param string $organizationUuid The organization UUID
- * @param array $objectData The organization object data (for nested contact persons)
- *
- * @return array Array of usernames
- */
- private function collectContactPersonUsernames(string $organizationUuid, array $objectData = []): array
+ * Collects all contact person usernames associated with an organization
+ *
+ * @param string $organizationUuid The organization UUID
+ * @param array $objectData The organization object data (for nested contact persons)
+ *
+ * @return array Array of usernames
+ */
+ private function collectContactPersonUsernames(string $organizationUuid, array $objectData=[]): array
{
$usernames = [];
-
- // Focus on nested contact persons in the organization object data
- // These are available immediately when the organization is created
+
+ // Focus on nested contact persons in the organization object data.
+ // These are available immediately when the organization is created.
$nestedContactPersons = $objectData['contactpersonen'] ?? [];
- $this->_logger->info('SoftwareCatalogueService: Processing nested contact persons', [
- 'organizationUuid' => $organizationUuid,
- 'nestedContactPersonCount' => count($nestedContactPersons)
- ]);
-
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Processing nested contact persons',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'nestedContactPersonCount' => count($nestedContactPersons),
+ ]
+ );
+
foreach ($nestedContactPersons as $contactPerson) {
- if (is_array($contactPerson) && isset($contactPerson['email'])) {
+ if (is_array($contactPerson) === true && isset($contactPerson['email']) === true) {
$usernames[] = $contactPerson['email'];
- $this->_logger->info('SoftwareCatalogueService: Added nested contact person username', [
- 'username' => $contactPerson['email'],
- 'contactPersonData' => $contactPerson
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Added nested contact person username',
+ [
+ 'username' => $contactPerson['email'],
+ 'contactPersonData' => $contactPerson,
+ ]
+ );
}
}
-
- // Also try to find existing contact persons by their organisatie field
- // This is useful for updates or when contact persons were created separately
- $objectService = $this->_getObjectService();
- if ($objectService) {
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+
+ // Also try to find existing contact persons by their organisatie field.
+ // This is useful for updates or when contact persons were created separately.
+ $objectService = $this->getObjectService();
+ if (empty($objectService) === false) {
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
$voorzieningenConfig = $settingsService->getVoorzieningenConfig();
- $contactSchemaId = $voorzieningenConfig['contactpersoon_schema'] ?? null;
-
- if (!$contactSchemaId) {
+ $contactSchemaId = $voorzieningenConfig['contactpersoon_schema'] ?? null;
+
+ if ($contactSchemaId === null) {
$this->_logger->warning('SoftwareCatalogueService: Missing contactpersoon schema configuration for username extraction');
return $usernames;
}
-
+
try {
- // Try multiple approaches to find contact persons
+ // Try multiple approaches to find contact persons.
$contactPersons = [];
-
- // Approach 1: Find by organisatie field
+
+ // Approach 1: Find by organisatie field.
try {
- $contactPersons = $objectService->findAll([
- 'filters' => [
- 'register' => $objectData['register'] ?? '6',
- 'schema' => $contactSchemaId,
- 'organisatie' => $organizationUuid
- ]
- ]);
+ $contactPersons = $objectService->findAll(
+ [
+ 'filters' => [
+ 'register' => $objectData['register'] ?? '6',
+ 'schema' => $contactSchemaId,
+ 'organisatie' => $organizationUuid,
+ ],
+ ]
+ );
} catch (\Exception $e) {
- $this->_logger->info('SoftwareCatalogueService: Approach 1 failed, trying approach 2', [
- 'organizationUuid' => $organizationUuid,
- 'error' => $e->getMessage()
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Approach 1 failed, trying approach 2',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'error' => $e->getMessage(),
+ ]
+ );
}
-
- // Approach 2: If approach 1 fails, try to find all contact persons and filter by organisatie
- if (empty($contactPersons)) {
+
+ // Approach 2: If approach 1 fails, try to find all contact persons and filter by organisatie.
+ if (empty($contactPersons) === true) {
try {
- $allContactPersons = $objectService->findAll([
- 'filters' => [
- 'register' => $objectData['register'] ?? '6',
- 'schema' => $contactSchemaId
- ]
- ]);
-
+ $allContactPersons = $objectService->findAll(
+ [
+ 'filters' => [
+ 'register' => $objectData['register'] ?? '6',
+ 'schema' => $contactSchemaId,
+ ],
+ ]
+ );
+
foreach ($allContactPersons as $contactPerson) {
- $contactData = $contactPerson->getObject();
+ $contactData = $contactPerson->getObject();
$contactOrganisatie = $contactData['organisatie'] ?? null;
if ($contactOrganisatie === $organizationUuid) {
$contactPersons[] = $contactPerson;
}
}
} catch (\Exception $e) {
- $this->_logger->info('SoftwareCatalogueService: Approach 2 also failed', [
- 'organizationUuid' => $organizationUuid,
- 'error' => $e->getMessage()
- ]);
- }
- }
-
- $this->_logger->info('SoftwareCatalogueService: Found existing contact persons for organization', [
- 'organizationUuid' => $organizationUuid,
- 'contactPersonCount' => count($contactPersons),
- 'contactPersonIds' => array_map(function($cp) { return $cp->getId(); }, $contactPersons)
- ]);
-
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Approach 2 also failed',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+ }//end if
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Found existing contact persons for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'contactPersonCount' => count($contactPersons),
+ 'contactPersonIds' => array_map(
+ function ($cp) {
+ return $cp->getId();
+ },
+ $contactPersons
+ ),
+ ]
+ );
+
foreach ($contactPersons as $contactPerson) {
$contactData = $contactPerson->getObject();
- $email = $contactData['email'] ?? null;
- if ($email) {
+ $email = $contactData['email'] ?? null;
+ if (empty($email) === false) {
$usernames[] = $email;
- $this->_logger->info('SoftwareCatalogueService: Added existing contact person username', [
- 'username' => $email,
- 'contactPersonId' => $contactPerson->getId()
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Added existing contact person username',
+ [
+ 'username' => $email,
+ 'contactPersonId' => $contactPerson->getId(),
+ ]
+ );
}
}
-
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: Error collecting existing contact person usernames', [
- 'organizationUuid' => $organizationUuid,
- 'error' => $e->getMessage()
- ]);
- }
- }
-
- // Remove duplicates and return
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Error collecting existing contact person usernames',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+ }//end if
+
+ // Remove duplicates and return.
$uniqueUsernames = array_unique($usernames);
- $this->_logger->info('SoftwareCatalogueService: Collected contact person usernames', [
- 'organizationUuid' => $organizationUuid,
- 'totalUsernames' => count($uniqueUsernames),
- 'usernames' => $uniqueUsernames
- ]);
-
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Collected contact person usernames',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'totalUsernames' => count($uniqueUsernames),
+ 'usernames' => $uniqueUsernames,
+ ]
+ );
+
return $uniqueUsernames;
- }
+ }//end collectContactPersonUsernames()
/**
* Maps organization data from SoftwareCatalog format to OpenRegister format
- *
+ *
* @param array $objectData The organization data from SoftwareCatalog
- *
+ *
* @return array The mapped data for OpenRegister
*/
private function mapOrganizationDataForOpenRegister(array $objectData): array
{
$mappedData = [
- 'naam' => $objectData['naam'] ?? $objectData['name'] ?? '',
- 'type' => $objectData['type'] ?? '',
- 'website' => $objectData['website'] ?? '',
- 'active' => false, // Default to inactive for new organizations
+ 'naam' => $objectData['naam'] ?? $objectData['name'] ?? '',
+ 'type' => $objectData['type'] ?? '',
+ 'website' => $objectData['website'] ?? '',
+ 'active' => false,
+ // Default to inactive for new organizations.
'contactpersonen' => [],
- 'deelnemers' => []
+ 'deelnemers' => [],
];
- // Map status from SoftwareCatalog to OpenRegister
+ // Map status from SoftwareCatalog to OpenRegister.
$beoordeling = strtolower($objectData['beoordeling'] ?? '');
if ($beoordeling === 'actief') {
$mappedData['active'] = true;
- } elseif ($beoordeling === 'inactief' || $beoordeling === 'deactief') {
+ } else if ($beoordeling === 'inactief' || $beoordeling === 'deactief') {
$mappedData['active'] = false;
}
- // Map other fields if they exist
- if (isset($objectData['adres'])) {
+ // Map other fields if they exist.
+ if (isset($objectData['adres']) === true) {
$mappedData['adres'] = $objectData['adres'];
}
- if (isset($objectData['postcode'])) {
+
+ if (isset($objectData['postcode']) === true) {
$mappedData['postcode'] = $objectData['postcode'];
}
- if (isset($objectData['plaats'])) {
+
+ if (isset($objectData['plaats']) === true) {
$mappedData['plaats'] = $objectData['plaats'];
}
- if (isset($objectData['telefoon'])) {
+
+ if (isset($objectData['telefoon']) === true) {
$mappedData['telefoon'] = $objectData['telefoon'];
}
- if (isset($objectData['email'])) {
+
+ if (isset($objectData['email']) === true) {
$mappedData['email'] = $objectData['email'];
}
return $mappedData;
- }
+ }//end mapOrganizationDataForOpenRegister()
/**
* Activates all users in an organization when the organization becomes active
*
* @param string $organizationUuid The organization UUID
- *
+ *
* @return void
*/
private function activateUsersForOrganization(string $organizationUuid): void
{
try {
- $this->_logger->info('SoftwareCatalogueService: Activating users for organization', [
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Activating users for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
- $objectService = $this->_getObjectService();
- if (!$objectService) {
+ $objectService = $this->getObjectService();
+ if ($objectService === null) {
$this->_logger->error('SoftwareCatalogueService: OpenRegister ObjectService not available');
return;
}
- // Get all contactpersonen for this organization
+ // Get all contactpersonen for this organization.
$settingsService = $this->_container->get(SettingsService::class);
- $registerId = $settingsService->getVoorzieningenRegisterId();
+ $registerId = $settingsService->getVoorzieningenRegisterId();
$contactpersoonSchemaId = $settingsService->getSchemaIdForObjectType('contactpersoon');
- if (!$registerId || !$contactpersoonSchemaId) {
+ if ($registerId === null || $contactpersoonSchemaId === false) {
$this->_logger->error('SoftwareCatalogueService: Register or schema not configured for contactpersonen');
return;
}
@@ -1837,73 +2024,81 @@ private function activateUsersForOrganization(string $organizationUuid): void
$contactpersoonSchemaId
);
- $userManager = $this->_container->get(\OCP\IUserManager::class);
+ $userManager = $this->_container->get(\OCP\IUserManager::class);
$activatedCount = 0;
foreach ($contactpersonen as $contactpersoon) {
$contactData = $contactpersoon->getObject();
- $username = $contactData['username'] ?? '';
+ $username = $contactData['username'] ?? '';
- if (!empty($username)) {
+ if (empty($username) === false) {
$user = $userManager->get($username);
- if ($user && !$user->isEnabled()) {
+ if ($user !== false && $user->isEnabled() === false) {
$user->setEnabled(true);
$activatedCount++;
- $this->_logger->info('SoftwareCatalogueService: Activated user for organization', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Activated user for organization',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
}
}
}
- $this->_logger->info('SoftwareCatalogueService: Completed user activation for organization', [
- 'organizationUuid' => $organizationUuid,
- 'totalContactpersonen' => count($contactpersonen),
- 'activatedUsers' => $activatedCount
- ]);
-
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Completed user activation for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'totalContactpersonen' => count($contactpersonen),
+ 'activatedUsers' => $activatedCount,
+ ]
+ );
} catch (\Exception $e) {
$this->_logger->error(
- 'SoftwareCatalogueService: Failed to activate users for organization: ' . $e->getMessage(),
+ 'SoftwareCatalogueService: Failed to activate users for organization: '.$e->getMessage(),
[
'organizationUuid' => $organizationUuid,
- 'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString()
+ 'exception' => $e->getMessage(),
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
]
);
- }
- }
+ }//end try
+ }//end activateUsersForOrganization()
/**
* Deactivates all users in an organization when the organization becomes inactive
*
* @param string $organizationUuid The organization UUID
- *
+ *
* @return void
*/
private function deactivateUsersForOrganization(string $organizationUuid): void
{
try {
- $this->_logger->info('SoftwareCatalogueService: Deactivating users for organization', [
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Deactivating users for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
- $objectService = $this->_getObjectService();
- if (!$objectService) {
+ $objectService = $this->getObjectService();
+ if ($objectService === null) {
$this->_logger->error('SoftwareCatalogueService: OpenRegister ObjectService not available');
return;
}
- // Get all contactpersonen for this organization
+ // Get all contactpersonen for this organization.
$settingsService = $this->_container->get(SettingsService::class);
- $registerId = $settingsService->getVoorzieningenRegisterId();
+ $registerId = $settingsService->getVoorzieningenRegisterId();
$contactpersoonSchemaId = $settingsService->getSchemaIdForObjectType('contactpersoon');
- if (!$registerId || !$contactpersoonSchemaId) {
+ if ($registerId === null || $contactpersoonSchemaId === false) {
$this->_logger->error('SoftwareCatalogueService: Register or schema not configured for contactpersonen');
return;
}
@@ -1914,283 +2109,355 @@ private function deactivateUsersForOrganization(string $organizationUuid): void
$contactpersoonSchemaId
);
- $userManager = $this->_container->get(\OCP\IUserManager::class);
+ $userManager = $this->_container->get(\OCP\IUserManager::class);
$deactivatedCount = 0;
foreach ($contactpersonen as $contactpersoon) {
$contactData = $contactpersoon->getObject();
- $username = $contactData['username'] ?? '';
+ $username = $contactData['username'] ?? '';
- if (!empty($username)) {
+ if (empty($username) === false) {
$user = $userManager->get($username);
- if ($user && $user->isEnabled()) {
+ if ($user !== false && $user->isEnabled() === true) {
$user->setEnabled(false);
$deactivatedCount++;
- $this->_logger->info('SoftwareCatalogueService: Deactivated user for organization', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Deactivated user for organization',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
}
}
}
- $this->_logger->info('SoftwareCatalogueService: Completed user deactivation for organization', [
- 'organizationUuid' => $organizationUuid,
- 'totalContactpersonen' => count($contactpersonen),
- 'deactivatedUsers' => $deactivatedCount
- ]);
-
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Completed user deactivation for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'totalContactpersonen' => count($contactpersonen),
+ 'deactivatedUsers' => $deactivatedCount,
+ ]
+ );
} catch (\Exception $e) {
$this->_logger->error(
- 'SoftwareCatalogueService: Failed to deactivate users for organization: ' . $e->getMessage(),
+ 'SoftwareCatalogueService: Failed to deactivate users for organization: '.$e->getMessage(),
[
'organizationUuid' => $organizationUuid,
- 'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString()
+ 'exception' => $e->getMessage(),
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
]
);
- }
- }
+ }//end try
+ }//end deactivateUsersForOrganization()
/**
* Activates SoftwareCatalog-specific users for an organization
* Only affects users from contactpersoon objects, not admin group users
*
* @param string $organizationUuid The organization UUID
- *
+ *
* @return void
*/
private function activateSoftwareCatalogUsersForOrganization(string $organizationUuid): void
{
try {
- $this->_logger->info('SoftwareCatalogueService: Activating SoftwareCatalog users for organization', [
- 'organizationUuid' => $organizationUuid
- ]);
-
- // Get SoftwareCatalog-specific users (from contactpersonen)
- $softwareCatalogUsers = $this->getSoftwareCatalogUsersForOrganization($organizationUuid);
-
- if (empty($softwareCatalogUsers)) {
- $this->_logger->info('SoftwareCatalogueService: No SoftwareCatalog users found for organization', [
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Activating SoftwareCatalog users for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+
+ // Get SoftwareCatalog-specific users (from contactpersonen).
+ $softwareCatalogUsers = $this->getSoftwareCatalogUsersForOrganization(organizationUuid: $organizationUuid);
+
+ if (empty($softwareCatalogUsers) === true) {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: No SoftwareCatalog users found for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return;
}
- $this->_logger->info('SoftwareCatalogueService: Found SoftwareCatalog users to activate', [
- 'organizationUuid' => $organizationUuid,
- 'userCount' => count($softwareCatalogUsers),
- 'users' => $softwareCatalogUsers
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Found SoftwareCatalog users to activate',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'userCount' => count($softwareCatalogUsers),
+ 'users' => $softwareCatalogUsers,
+ ]
+ );
- // Get the user manager
- $userManager = \OC::$server->getUserManager();
+ // Get the user manager.
+ $userManager = \OC::$server->getUserManager();
$activatedUsers = [];
- $failedUsers = [];
+ $failedUsers = [];
foreach ($softwareCatalogUsers as $username) {
try {
$user = $userManager->get($username);
- if ($user && !$user->isEnabled()) {
+ if ($user !== false && $user->isEnabled() === false) {
$user->setEnabled(true);
$activatedUsers[] = $username;
- $this->_logger->debug('SoftwareCatalogueService: Activated SoftwareCatalog user', [
- 'organizationUuid' => $organizationUuid,
- 'username' => $username
- ]);
- } elseif ($user && $user->isEnabled()) {
- $this->_logger->debug('SoftwareCatalogueService: SoftwareCatalog user already active', [
- 'organizationUuid' => $organizationUuid,
- 'username' => $username
- ]);
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Activated SoftwareCatalog user',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'username' => $username,
+ ]
+ );
+ } else if ($user !== false && $user->isEnabled() === true) {
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: SoftwareCatalog user already active',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'username' => $username,
+ ]
+ );
} else {
$failedUsers[] = $username;
- $this->_logger->warning('SoftwareCatalogueService: SoftwareCatalog user not found', [
- 'organizationUuid' => $organizationUuid,
- 'username' => $username
- ]);
- }
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: SoftwareCatalog user not found',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'username' => $username,
+ ]
+ );
+ }//end if
} catch (\Exception $e) {
$failedUsers[] = $username;
- $this->_logger->error('SoftwareCatalogueService: Failed to activate SoftwareCatalog user', [
- 'organizationUuid' => $organizationUuid,
- 'username' => $username,
- 'error' => $e->getMessage()
- ]);
- }
- }
-
- $this->_logger->info('SoftwareCatalogueService: SoftwareCatalog user activation complete', [
- 'organizationUuid' => $organizationUuid,
- 'activatedUsers' => $activatedUsers,
- 'failedUsers' => $failedUsers,
- 'totalProcessed' => count($softwareCatalogUsers)
- ]);
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Failed to activate SoftwareCatalog user',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'username' => $username,
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+ }//end foreach
+ $this->_logger->info(
+ 'SoftwareCatalogueService: SoftwareCatalog user activation complete',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'activatedUsers' => $activatedUsers,
+ 'failedUsers' => $failedUsers,
+ 'totalProcessed' => count($softwareCatalogUsers),
+ ]
+ );
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: Error activating SoftwareCatalog users for organization', [
- 'organizationUuid' => $organizationUuid,
- 'error' => $e->getMessage()
- ]);
- }
- }
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Error activating SoftwareCatalog users for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+ }//end activateSoftwareCatalogUsersForOrganization()
/**
* Deactivates SoftwareCatalog-specific users for an organization
* Only affects users from contactpersoon objects, not admin group users
*
* @param string $organizationUuid The organization UUID
- *
+ *
* @return void
*/
private function deactivateSoftwareCatalogUsersForOrganization(string $organizationUuid): void
{
try {
- $this->_logger->info('SoftwareCatalogueService: Deactivating SoftwareCatalog users for organization', [
- 'organizationUuid' => $organizationUuid
- ]);
-
- // Get SoftwareCatalog-specific users (from contactpersonen)
- $softwareCatalogUsers = $this->getSoftwareCatalogUsersForOrganization($organizationUuid);
-
- if (empty($softwareCatalogUsers)) {
- $this->_logger->info('SoftwareCatalogueService: No SoftwareCatalog users found for organization', [
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Deactivating SoftwareCatalog users for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+
+ // Get SoftwareCatalog-specific users (from contactpersonen).
+ $softwareCatalogUsers = $this->getSoftwareCatalogUsersForOrganization(organizationUuid: $organizationUuid);
+
+ if (empty($softwareCatalogUsers) === true) {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: No SoftwareCatalog users found for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return;
}
- $this->_logger->info('SoftwareCatalogueService: Found SoftwareCatalog users to deactivate', [
- 'organizationUuid' => $organizationUuid,
- 'userCount' => count($softwareCatalogUsers),
- 'users' => $softwareCatalogUsers
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Found SoftwareCatalog users to deactivate',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'userCount' => count($softwareCatalogUsers),
+ 'users' => $softwareCatalogUsers,
+ ]
+ );
- // Get the user manager
- $userManager = \OC::$server->getUserManager();
+ // Get the user manager.
+ $userManager = \OC::$server->getUserManager();
$deactivatedUsers = [];
- $failedUsers = [];
+ $failedUsers = [];
foreach ($softwareCatalogUsers as $username) {
try {
$user = $userManager->get($username);
- if ($user && $user->isEnabled()) {
+ if ($user !== false && $user->isEnabled() === true) {
$user->setEnabled(false);
$deactivatedUsers[] = $username;
- $this->_logger->debug('SoftwareCatalogueService: Deactivated SoftwareCatalog user', [
- 'organizationUuid' => $organizationUuid,
- 'username' => $username
- ]);
- } elseif ($user && !$user->isEnabled()) {
- $this->_logger->debug('SoftwareCatalogueService: SoftwareCatalog user already inactive', [
- 'organizationUuid' => $organizationUuid,
- 'username' => $username
- ]);
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Deactivated SoftwareCatalog user',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'username' => $username,
+ ]
+ );
+ } else if ($user !== false && $user->isEnabled() === false) {
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: SoftwareCatalog user already inactive',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'username' => $username,
+ ]
+ );
} else {
$failedUsers[] = $username;
- $this->_logger->warning('SoftwareCatalogueService: SoftwareCatalog user not found', [
- 'organizationUuid' => $organizationUuid,
- 'username' => $username
- ]);
- }
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: SoftwareCatalog user not found',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'username' => $username,
+ ]
+ );
+ }//end if
} catch (\Exception $e) {
$failedUsers[] = $username;
- $this->_logger->error('SoftwareCatalogueService: Failed to deactivate SoftwareCatalog user', [
- 'organizationUuid' => $organizationUuid,
- 'username' => $username,
- 'error' => $e->getMessage()
- ]);
- }
- }
-
- $this->_logger->info('SoftwareCatalogueService: SoftwareCatalog user deactivation complete', [
- 'organizationUuid' => $organizationUuid,
- 'deactivatedUsers' => $deactivatedUsers,
- 'failedUsers' => $failedUsers,
- 'totalProcessed' => count($softwareCatalogUsers)
- ]);
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Failed to deactivate SoftwareCatalog user',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'username' => $username,
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+ }//end foreach
+ $this->_logger->info(
+ 'SoftwareCatalogueService: SoftwareCatalog user deactivation complete',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'deactivatedUsers' => $deactivatedUsers,
+ 'failedUsers' => $failedUsers,
+ 'totalProcessed' => count($softwareCatalogUsers),
+ ]
+ );
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: Error deactivating SoftwareCatalog users for organization', [
- 'organizationUuid' => $organizationUuid,
- 'error' => $e->getMessage()
- ]);
- }
- }
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Error deactivating SoftwareCatalog users for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+ }//end deactivateSoftwareCatalogUsersForOrganization()
/**
* Gets SoftwareCatalog-specific users for an organization
* These are users from contactpersoon objects, excluding admin group users
*
* @param string $organizationUuid The organization UUID
- *
+ *
* @return array Array of usernames
*/
private function getSoftwareCatalogUsersForOrganization(string $organizationUuid): array
{
try {
- $this->_logger->debug('SoftwareCatalogueService: Getting SoftwareCatalog users for organization', [
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Getting SoftwareCatalog users for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
- // Get the object service to find contactpersonen
- $objectService = $this->_getObjectService();
- if (!$objectService) {
+ // Get the object service to find contactpersonen.
+ $objectService = $this->getObjectService();
+ if ($objectService === null) {
$this->_logger->error('SoftwareCatalogueService: ObjectService not available for getting SoftwareCatalog users');
return [];
}
- // Find all contactpersonen for this organization
- $contactpersonen = $objectService->findAll([
- 'filters' => [
- 'register' => 6, // Voorzieningen register
- 'schema' => 38 // Contactpersoon schema
- ]
- ]);
+ // Find all contactpersonen for this organization.
+ $contactpersonen = $objectService->findAll(
+ [
+ 'filters' => [
+ 'register' => 6,
+ // Voorzieningen register.
+ 'schema' => 38,
+ // Contactpersoon schema.
+ ],
+ ]
+ );
$softwareCatalogUsers = [];
- $adminGroupUsers = $this->getAdminGroupUsernames();
+ $adminGroupUsers = $this->getAdminGroupUsernames();
foreach ($contactpersonen as $contactpersoonObject) {
- $contactData = $contactpersoonObject->getObject();
+ $contactData = $contactpersoonObject->getObject();
$contactOrganisatie = $contactData['organisatie'] ?? null;
-
- // Check if this contactpersoon belongs to our organization
+
+ // Check if this contactpersoon belongs to our organization.
if ($contactOrganisatie === $organizationUuid) {
- // Extract username from contactpersoon object data
+ // Extract username from contactpersoon object data.
$contactData = $contactpersoonObject->getObject();
- $username = $contactData['username'] ?? null;
-
- if ($username && !in_array($username, $adminGroupUsers)) {
+ $username = $contactData['username'] ?? null;
+
+ if ($username !== false && in_array($username, $adminGroupUsers) === false) {
$softwareCatalogUsers[] = $username;
- $this->_logger->debug('SoftwareCatalogueService: Found SoftwareCatalog user', [
- 'organizationUuid' => $organizationUuid,
- 'username' => $username,
- 'contactpersoonId' => $contactpersoonObject->getId()
- ]);
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Found SoftwareCatalog user',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'username' => $username,
+ 'contactpersoonId' => $contactpersoonObject->getId(),
+ ]
+ );
}
}
- }
+ }//end foreach
- $this->_logger->info('SoftwareCatalogueService: Found SoftwareCatalog users for organization', [
- 'organizationUuid' => $organizationUuid,
- 'userCount' => count($softwareCatalogUsers),
- 'users' => $softwareCatalogUsers
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Found SoftwareCatalog users for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'userCount' => count($softwareCatalogUsers),
+ 'users' => $softwareCatalogUsers,
+ ]
+ );
return $softwareCatalogUsers;
-
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: Error getting SoftwareCatalog users for organization', [
- 'organizationUuid' => $organizationUuid,
- 'error' => $e->getMessage()
- ]);
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Error getting SoftwareCatalog users for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'error' => $e->getMessage(),
+ ]
+ );
return [];
- }
- }
+ }//end try
+ }//end getSoftwareCatalogUsersForOrganization()
/**
* Gets all usernames from the admin group
@@ -2201,284 +2468,334 @@ private function getAdminGroupUsernames(): array
{
try {
$groupManager = \OC::$server->getGroupManager();
- $adminGroup = $groupManager->get('admin');
-
- if (!$adminGroup) {
+ $adminGroup = $groupManager->get('admin');
+
+ if ($adminGroup === null) {
$this->_logger->warning('SoftwareCatalogueService: Admin group not found');
return [];
}
- $adminUsers = $adminGroup->getUsers();
+ $adminUsers = $adminGroup->getUsers();
$adminUsernames = [];
-
+
foreach ($adminUsers as $adminUser) {
$adminUsernames[] = $adminUser->getUID();
}
- $this->_logger->debug('SoftwareCatalogueService: Found admin group users', [
- 'adminUserCount' => count($adminUsernames),
- 'adminUsers' => $adminUsernames
- ]);
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Found admin group users',
+ [
+ 'adminUserCount' => count($adminUsernames),
+ 'adminUsers' => $adminUsernames,
+ ]
+ );
return $adminUsernames;
-
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: Error getting admin group usernames', [
- 'error' => $e->getMessage()
- ]);
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Error getting admin group usernames',
+ [
+ 'error' => $e->getMessage(),
+ ]
+ );
return [];
- }
- }
+ }//end try
+ }//end getAdminGroupUsernames()
/**
* Adds all users from the admin group to the organization entity
*
* @param string $organizationUuid The organization UUID
- *
+ *
* @return void
*/
private function addAdminGroupUsersToOrganization(string $organizationUuid): void
{
try {
- $this->_logger->info('SoftwareCatalogueService: Adding admin group users to organization entity', [
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Adding admin group users to organization entity',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
- // Get the group manager to access admin group users
+ // Get the group manager to access admin group users.
$groupManager = \OC::$server->getGroupManager();
- $adminGroup = $groupManager->get('admin');
-
- if (!$adminGroup) {
+ $adminGroup = $groupManager->get('admin');
+
+ if ($adminGroup === null) {
$this->_logger->warning('SoftwareCatalogueService: Admin group not found');
return;
}
$adminUsers = $adminGroup->getUsers();
- $this->_logger->info('SoftwareCatalogueService: Found admin group users', [
- 'organizationUuid' => $organizationUuid,
- 'adminUserCount' => count($adminUsers)
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Found admin group users',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'adminUserCount' => count($adminUsers),
+ ]
+ );
- // Get the organization entity (not object) to update its users list
+ // Get the organization entity (not object) to update its users list.
$organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
- if (!$organisationMapper) {
+ if ($organisationMapper === null) {
$this->_logger->error('SoftwareCatalogueService: OrganisationMapper not available for adding admin users');
return;
}
- // Find the organization entity by UUID
- $this->_logger->info('SoftwareCatalogueService: Searching for organization entity', [
- 'organizationUuid' => $organizationUuid
- ]);
-
+ // Find the organization entity by UUID.
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Searching for organization entity',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+
try {
$targetOrganisation = $organisationMapper->findByUuid($organizationUuid);
-
- $this->_logger->info('SoftwareCatalogueService: Found target organization entity', [
- 'organizationUuid' => $organizationUuid,
- 'entityId' => $targetOrganisation->getId()
- ]);
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Found target organization entity',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'entityId' => $targetOrganisation->getId(),
+ ]
+ );
} catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
- $this->_logger->warning('SoftwareCatalogueService: Organization entity not found for adding admin users', [
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Organization entity not found for adding admin users',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return;
}
- // Get current users list from the entity
+ // Get current users list from the entity.
$currentUsers = $targetOrganisation->getUsers() ?? [];
-
- $this->_logger->info('SoftwareCatalogueService: Current organization entity users', [
- 'organizationUuid' => $organizationUuid,
- 'currentUsers' => $currentUsers,
- 'currentUserCount' => count($currentUsers)
- ]);
-
- // Add admin users to the list
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Current organization entity users',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'currentUsers' => $currentUsers,
+ 'currentUserCount' => count($currentUsers),
+ ]
+ );
+
+ // Add admin users to the list.
$updatedUsers = $currentUsers;
- $addedUsers = [];
+ $addedUsers = [];
foreach ($adminUsers as $adminUser) {
$adminUsername = $adminUser->getUID();
- if (!in_array($adminUsername, $updatedUsers)) {
+ if (in_array($adminUsername, $updatedUsers) === false) {
$updatedUsers[] = $adminUsername;
- $addedUsers[] = $adminUsername;
- $this->_logger->debug('SoftwareCatalogueService: Added admin user to organization entity', [
- 'organizationUuid' => $organizationUuid,
- 'adminUsername' => $adminUsername
- ]);
+ $addedUsers[] = $adminUsername;
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Added admin user to organization entity',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'adminUsername' => $adminUsername,
+ ]
+ );
}
}
-
- $this->_logger->info('SoftwareCatalogueService: Admin users processing complete', [
- 'organizationUuid' => $organizationUuid,
- 'addedUsers' => $addedUsers,
- 'totalUsersAfterUpdate' => count($updatedUsers)
- ]);
-
- // Update the organization entity with the new users list
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Admin users processing complete',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'addedUsers' => $addedUsers,
+ 'totalUsersAfterUpdate' => count($updatedUsers),
+ ]
+ );
+
+ // Update the organization entity with the new users list.
if (count($updatedUsers) > count($currentUsers)) {
- $this->_logger->info('SoftwareCatalogueService: Updating organization entity with new users', [
- 'organizationUuid' => $organizationUuid,
- 'entityId' => $targetOrganisation->getId(),
- 'usersToAdd' => count($updatedUsers) - count($currentUsers)
- ]);
-
- // Set the updated users list on the entity
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Updating organization entity with new users',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'entityId' => $targetOrganisation->getId(),
+ 'usersToAdd' => count($updatedUsers) - count($currentUsers),
+ ]
+ );
+
+ // Set the updated users list on the entity.
$targetOrganisation->setUsers($updatedUsers);
-
- $this->_logger->info('SoftwareCatalogueService: Saving updated organization entity', [
- 'organizationUuid' => $organizationUuid,
- 'entityId' => $targetOrganisation->getId(),
- 'newUserCount' => count($updatedUsers)
- ]);
-
- // Save the updated organization entity
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Saving updated organization entity',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'entityId' => $targetOrganisation->getId(),
+ 'newUserCount' => count($updatedUsers),
+ ]
+ );
+
+ // Save the updated organization entity.
$savedOrganisation = $organisationMapper->save($targetOrganisation);
-
- $this->_logger->info('SoftwareCatalogueService: Successfully added admin users to organization entity', [
- 'organizationUuid' => $organizationUuid,
- 'addedUsers' => count($updatedUsers) - count($currentUsers),
- 'totalUsers' => count($updatedUsers)
- ]);
- } else {
- $this->_logger->info('SoftwareCatalogueService: All admin users already in organization entity', [
- 'organizationUuid' => $organizationUuid,
- 'totalUsers' => count($updatedUsers)
- ]);
- }
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully added admin users to organization entity',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'addedUsers' => count($updatedUsers) - count($currentUsers),
+ 'totalUsers' => count($updatedUsers),
+ ]
+ );
+ } else {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: All admin users already in organization entity',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'totalUsers' => count($updatedUsers),
+ ]
+ );
+ }//end if
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: Failed to add admin users to organization entity: ' . $e->getMessage(), [
- 'organizationUuid' => $organizationUuid,
- 'exception' => $e
- ]);
- }
- }
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Failed to add admin users to organization entity: '.$e->getMessage(),
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'exception' => $e,
+ ]
+ );
+ }//end try
+ }//end addAdminGroupUsersToOrganization()
/**
* Checks if a contactpersoon username is in the organization's users list
*
* @param object $contactpersoonObject The contactpersoon object
- *
+ *
* @return bool True if the user should be added to the organization
*/
public function shouldAddContactpersoonToOrganization(object $contactpersoonObject): bool
{
try {
- $objectData = $contactpersoonObject->getObject();
- $username = $objectData['username'] ?? '';
+ $objectData = $contactpersoonObject->getObject();
+ $username = $objectData['username'] ?? '';
$organizationUuid = $objectData['organisation'] ?? '';
- if (empty($username) || empty($organizationUuid)) {
+ if (empty($username) === true || empty($organizationUuid) === true) {
return false;
}
- $objectService = $this->_getObjectService();
- if (!$objectService) {
+ $objectService = $this->getObjectService();
+ if ($objectService === null) {
return false;
}
- // Get the organization object
- $settingsService = $this->_container->get(SettingsService::class);
- $registerId = $settingsService->getVoorzieningenRegisterId();
+ // Get the organization object.
+ $settingsService = $this->_container->get(SettingsService::class);
+ $registerId = $settingsService->getVoorzieningenRegisterId();
$organisatieSchemaId = $settingsService->getSchemaIdForObjectType('organisatie');
- if (!$registerId || !$organisatieSchemaId) {
+ if ($registerId === null || $organisatieSchemaId === false) {
return false;
}
try {
$organizationObject = $objectService->find($organizationUuid, [], false, $registerId, $organisatieSchemaId);
- $organizationData = $organizationObject->getObject();
-
- // Check if the username is already in the organization's users
+ $organizationData = $organizationObject->getObject();
+
+ // Check if the username is already in the organization's users.
$organizationUsers = $organizationData['users'] ?? [];
-
- if (is_array($organizationUsers) && !in_array($username, $organizationUsers)) {
- $this->_logger->info('SoftwareCatalogueService: Contactpersoon should be added to organization', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid,
- 'currentUsers' => $organizationUsers
- ]);
+
+ if (is_array($organizationUsers) === true && in_array($username, $organizationUsers) === false) {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Contactpersoon should be added to organization',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ 'currentUsers' => $organizationUsers,
+ ]
+ );
return true;
}
return false;
-
} catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
- // Organization doesn't exist, so we can't add the user
- $this->_logger->warning('SoftwareCatalogueService: Organization not found for contactpersoon', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
+ // Organization doesn't exist, so we can't add the user.
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Organization not found for contactpersoon',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return false;
- }
-
+ }//end try
} catch (\Exception $e) {
$this->_logger->error(
- 'SoftwareCatalogueService: Failed to check if contactpersoon should be added to organization: ' . $e->getMessage(),
+ 'SoftwareCatalogueService: Failed to check if contactpersoon should be added to organization: '.$e->getMessage(),
[
- 'objectId' => $contactpersoonObject->getId(),
- 'exception' => $e->getMessage()
+ 'objectId' => $contactpersoonObject->getId(),
+ 'exception' => $e->getMessage(),
]
);
return false;
- }
- }
+ }//end try
+ }//end shouldAddContactpersoonToOrganization()
/**
* Adds a contactpersoon username to the organization's users list
*
* @param object $contactpersoonObject The contactpersoon object
- *
+ *
* @return bool True if the user was successfully added
*/
public function addContactpersoonToOrganization(object $contactpersoonObject): bool
{
try {
- $objectData = $contactpersoonObject->getObject();
- $username = $objectData['username'] ?? '';
+ $objectData = $contactpersoonObject->getObject();
+ $username = $objectData['username'] ?? '';
$organizationUuid = $objectData['organisation'] ?? '';
- if (empty($username) || empty($organizationUuid)) {
- $this->_logger->warning('SoftwareCatalogueService: Cannot add contactpersoon to organization - missing username or organization', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
+ if (empty($username) === true || empty($organizationUuid) === true) {
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Cannot add contactpersoon to organization - missing username or organization',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return false;
}
- $objectService = $this->_getObjectService();
- if (!$objectService) {
+ $objectService = $this->getObjectService();
+ if ($objectService === null) {
$this->_logger->error('SoftwareCatalogueService: OpenRegister ObjectService not available');
return false;
}
- // Get the organization object
- $settingsService = $this->_container->get(SettingsService::class);
- $registerId = $settingsService->getVoorzieningenRegisterId();
+ // Get the organization object.
+ $settingsService = $this->_container->get(SettingsService::class);
+ $registerId = $settingsService->getVoorzieningenRegisterId();
$organisatieSchemaId = $settingsService->getSchemaIdForObjectType('organisatie');
- if (!$registerId || !$organisatieSchemaId) {
+ if ($registerId === null || $organisatieSchemaId === false) {
$this->_logger->error('SoftwareCatalogueService: Register or schema not configured for organisatie');
return false;
}
try {
$organizationObject = $objectService->find($organizationUuid, [], false, $registerId, $organisatieSchemaId);
- $organizationData = $organizationObject->getObject();
-
- // Add the username to the organization's users list
+ $organizationData = $organizationObject->getObject();
+
+ // Add the username to the organization's users list.
$organizationUsers = $organizationData['users'] ?? [];
- if (!is_array($organizationUsers)) {
+ if (is_array($organizationUsers) === false) {
$organizationUsers = [];
}
-
- if (!in_array($username, $organizationUsers)) {
- $organizationUsers[] = $username;
+
+ if (in_array($username, $organizationUsers) === false) {
+ $organizationUsers[] = $username;
$organizationData['users'] = $organizationUsers;
-
- // Update the organization object
+
+ // Update the organization object.
$updatedOrganization = $objectService->saveObject(
$organizationData,
[],
@@ -2487,162 +2804,190 @@ public function addContactpersoonToOrganization(object $contactpersoonObject): b
$organizationUuid
);
- $this->_logger->info('SoftwareCatalogueService: Successfully added contactpersoon to organization', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid,
- 'updatedUsers' => $organizationUsers
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully added contactpersoon to organization',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ 'updatedUsers' => $organizationUsers,
+ ]
+ );
return true;
} else {
- $this->_logger->debug('SoftwareCatalogueService: Contactpersoon already in organization', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
- return true; // Already there, consider it successful
- }
-
+ $this->_logger->debug(
+ 'SoftwareCatalogueService: Contactpersoon already in organization',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+ return true;
+ // Already there, consider it successful.
+ }//end if
} catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
- $this->_logger->error('SoftwareCatalogueService: Organization not found for contactpersoon', [
- 'username' => $username,
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Organization not found for contactpersoon',
+ [
+ 'username' => $username,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return false;
- }
-
+ }//end try
} catch (\Exception $e) {
$this->_logger->error(
- 'SoftwareCatalogueService: Failed to add contactpersoon to organization: ' . $e->getMessage(),
+ 'SoftwareCatalogueService: Failed to add contactpersoon to organization: '.$e->getMessage(),
[
- 'objectId' => $contactpersoonObject->getId(),
+ 'objectId' => $contactpersoonObject->getId(),
'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString()
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
]
);
return false;
- }
- }
+ }//end try
+ }//end addContactpersoonToOrganization()
/**
* Handles ownership assignment for anonymous user registrations
- *
+ *
* @param object $organizationObject The organization object
- *
+ *
* @return void
*/
private function handleOwnershipAssignment(object $organizationObject): void
{
try {
- $this->_logger->info('SoftwareCatalogueService: Handling ownership assignment for organization', [
- 'objectId' => $organizationObject->getId()
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Handling ownership assignment for organization',
+ [
+ 'objectId' => $organizationObject->getId(),
+ ]
+ );
- $objectData = $organizationObject->getObject();
+ $objectData = $organizationObject->getObject();
$organizationUuid = $objectData['id'] ?? $organizationObject->getId();
- $contactpersonen = $objectData['contactpersonen'] ?? [];
+ $contactpersonen = $objectData['contactpersonen'] ?? [];
- if (empty($contactpersonen)) {
- $this->_logger->info('SoftwareCatalogueService: No contact persons found for ownership assignment', [
- 'organizationUuid' => $organizationUuid
- ]);
+ if (empty($contactpersonen) === true) {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: No contact persons found for ownership assignment',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return;
}
- // Get the first contact person as the primary owner
+ // Get the first contact person as the primary owner.
$primaryContactUuid = $contactpersonen[0];
-
- $objectService = $this->_getObjectService();
- if (!$objectService) {
+
+ $objectService = $this->getObjectService();
+ if ($objectService === null) {
$this->_logger->error('SoftwareCatalogueService: OpenRegister ObjectService not available for ownership assignment');
return;
}
- // Get the primary contact person object
+ // Get the primary contact person object.
$settingsService = $this->_container->get(SettingsService::class);
- $registerId = $settingsService->getVoorzieningenRegisterId();
+ $registerId = $settingsService->getVoorzieningenRegisterId();
$contactpersoonSchemaId = $settingsService->getSchemaIdForObjectType('contactpersoon');
- $organisatieSchemaId = $settingsService->getSchemaIdForObjectType('organisatie');
+ $organisatieSchemaId = $settingsService->getSchemaIdForObjectType('organisatie');
- if (!$registerId || !$contactpersoonSchemaId || !$organisatieSchemaId) {
+ if ($registerId === null || $contactpersoonSchemaId === null || $organisatieSchemaId === false) {
$this->_logger->error('SoftwareCatalogueService: Register or schema not configured for contactpersoon or organisatie');
return;
}
- // Retry mechanism for user creation timing
+ // Retry mechanism for user creation timing.
$maxRetries = 3;
- $retryDelay = 1; // seconds
-
+ $retryDelay = 1;
+ // Seconds.
for ($retry = 0; $retry < $maxRetries; $retry++) {
try {
$primaryContactObject = $objectService->find($primaryContactUuid, [], false, $registerId, $contactpersoonSchemaId);
- $primaryContactData = $primaryContactObject->getObject();
- $primaryUsername = $primaryContactData['username'] ?? '';
+ $primaryContactData = $primaryContactObject->getObject();
+ $primaryUsername = $primaryContactData['username'] ?? '';
- if (empty($primaryUsername)) {
+ if (empty($primaryUsername) === true) {
if ($retry < $maxRetries - 1) {
- $this->_logger->info('SoftwareCatalogueService: Primary contact person has no username, retrying in ' . $retryDelay . ' seconds', [
- 'contactUuid' => $primaryContactUuid,
- 'organizationUuid' => $organizationUuid,
- 'retry' => $retry + 1,
- 'maxRetries' => $maxRetries
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Primary contact person has no username, retrying in '.$retryDelay.' seconds',
+ [
+ 'contactUuid' => $primaryContactUuid,
+ 'organizationUuid' => $organizationUuid,
+ 'retry' => $retry + 1,
+ 'maxRetries' => $maxRetries,
+ ]
+ );
sleep($retryDelay);
continue;
} else {
- $this->_logger->warning('SoftwareCatalogueService: Primary contact person still has no username after retries', [
- 'contactUuid' => $primaryContactUuid,
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Primary contact person still has no username after retries',
+ [
+ 'contactUuid' => $primaryContactUuid,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return;
- }
- }
-
- // Get the organization entity UUID - use the same UUID as the organization object
- $organisationEntityUuid = $organizationUuid; // Organization entity should have same UUID as object
+ }//end if
+ }//end if
- // Add users to the organization entity
+ // Get the organization entity UUID - use the same UUID as the organization object.
+ $organisationEntityUuid = $organizationUuid;
+ // Organization entity should have same UUID as object.
+ // Add users to the organization entity.
$organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
try {
$organisationEntity = $organisationMapper->findByUuid($organisationEntityUuid);
-
- // Add all contact person users to the organization entity
+
+ // Add all contact person users to the organization entity.
foreach ($contactpersonen as $contactUuid) {
try {
- $contactObject = $objectService->find($contactUuid, [], false, $registerId, $contactpersoonSchemaId);
- $contactData = $contactObject->getObject();
+ $contactObject = $objectService->find($contactUuid, [], false, $registerId, $contactpersoonSchemaId);
+ $contactData = $contactObject->getObject();
$contactUsername = $contactData['username'] ?? '';
-
- if (!empty($contactUsername)) {
+
+ if (empty($contactUsername) === false) {
$organisationEntity->addUser($contactUsername);
}
} catch (\Exception $e) {
- $this->_logger->warning('SoftwareCatalogueService: Failed to add contact person to organization entity', [
- 'contactUuid' => $contactUuid,
- 'error' => $e->getMessage()
- ]);
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Failed to add contact person to organization entity',
+ [
+ 'contactUuid' => $contactUuid,
+ 'error' => $e->getMessage(),
+ ]
+ );
}
}
-
- // Save the updated organization entity
+
+ // Save the updated organization entity.
$organisationMapper->save($organisationEntity);
-
- $this->_logger->info('SoftwareCatalogueService: Successfully added users to organization entity', [
- 'organizationUuid' => $organisationEntityUuid,
- 'userCount' => count($organisationEntity->getUserIds())
- ]);
-
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully added users to organization entity',
+ [
+ 'organizationUuid' => $organisationEntityUuid,
+ 'userCount' => count($organisationEntity->getUserIds()),
+ ]
+ );
} catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
- $this->_logger->error('SoftwareCatalogueService: Organization entity not found for adding users', [
- 'organizationUuid' => $organisationEntityUuid
- ]);
- }
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Organization entity not found for adding users',
+ [
+ 'organizationUuid' => $organisationEntityUuid,
+ ]
+ );
+ }//end try
- // Update organization object ownership and organization reference
- $organizationData['owner'] = $primaryUsername;
+ // Update organization object ownership and organization reference.
+ $organizationData['owner'] = $primaryUsername;
$organizationData['organisation'] = $organisationEntityUuid;
-
+
$updatedOrganization = $objectService->saveObject(
$organizationData,
[],
@@ -2651,10 +2996,10 @@ private function handleOwnershipAssignment(object $organizationObject): void
$organizationUuid
);
- // Update primary contact person object ownership and organization reference
- $primaryContactData['owner'] = $primaryUsername;
+ // Update primary contact person object ownership and organization reference.
+ $primaryContactData['owner'] = $primaryUsername;
$primaryContactData['organisatie'] = $organisationEntityUuid;
-
+
$updatedPrimaryContact = $objectService->saveObject(
$primaryContactData,
[],
@@ -2663,18 +3008,18 @@ private function handleOwnershipAssignment(object $organizationObject): void
$primaryContactUuid
);
- // Update other contact persons with organization reference
+ // Update other contact persons with organization reference.
for ($i = 1; $i < count($contactpersonen); $i++) {
$contactUuid = $contactpersonen[$i];
try {
- $contactObject = $objectService->find($contactUuid, [], false, $registerId, $contactpersoonSchemaId);
- $contactData = $contactObject->getObject();
+ $contactObject = $objectService->find($contactUuid, [], false, $registerId, $contactpersoonSchemaId);
+ $contactData = $contactObject->getObject();
$contactUsername = $contactData['username'] ?? '';
- if (!empty($contactUsername)) {
- $contactData['owner'] = $contactUsername;
+ if (empty($contactUsername) === false) {
+ $contactData['owner'] = $contactUsername;
$contactData['organisatie'] = $organisationEntityUuid;
-
+
$objectService->saveObject(
$contactData,
[],
@@ -2684,383 +3029,469 @@ private function handleOwnershipAssignment(object $organizationObject): void
);
}
} catch (\Exception $e) {
- $this->_logger->warning('SoftwareCatalogueService: Failed to update contact person ownership', [
- 'contactUuid' => $contactUuid,
- 'error' => $e->getMessage()
- ]);
- }
- }
-
- $this->_logger->info('SoftwareCatalogueService: Successfully assigned ownership for organization', [
- 'organizationUuid' => $organizationUuid,
- 'primaryOwner' => $primaryUsername,
- 'organisationEntityUuid' => $organisationEntityUuid,
- 'contactPersonCount' => count($contactpersonen),
- 'retries' => $retry
- ]);
-
- return; // Success, exit retry loop
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Failed to update contact person ownership',
+ [
+ 'contactUuid' => $contactUuid,
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+ }//end for
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully assigned ownership for organization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'primaryOwner' => $primaryUsername,
+ 'organisationEntityUuid' => $organisationEntityUuid,
+ 'contactPersonCount' => count($contactpersonen),
+ 'retries' => $retry,
+ ]
+ );
+ return;
+ // Success, exit retry loop.
} catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
if ($retry < $maxRetries - 1) {
- $this->_logger->info('SoftwareCatalogueService: Primary contact person not found, retrying in ' . $retryDelay . ' seconds', [
- 'contactUuid' => $primaryContactUuid,
- 'organizationUuid' => $organizationUuid,
- 'retry' => $retry + 1,
- 'maxRetries' => $maxRetries
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Primary contact person not found, retrying in '.$retryDelay.' seconds',
+ [
+ 'contactUuid' => $primaryContactUuid,
+ 'organizationUuid' => $organizationUuid,
+ 'retry' => $retry + 1,
+ 'maxRetries' => $maxRetries,
+ ]
+ );
sleep($retryDelay);
continue;
} else {
- $this->_logger->error('SoftwareCatalogueService: Primary contact person not found after retries', [
- 'contactUuid' => $primaryContactUuid,
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Primary contact person not found after retries',
+ [
+ 'contactUuid' => $primaryContactUuid,
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return;
- }
- }
- }
-
+ }//end if
+ }//end try
+ }//end for
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: Error handling ownership assignment', [
- 'objectId' => $organizationObject->getId(),
- 'error' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine()
- ]);
- }
- }
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Error handling ownership assignment',
+ [
+ 'objectId' => $organizationObject->getId(),
+ 'error' => $e->getMessage(),
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ ]
+ );
+ }//end try
+ }//end handleOwnershipAssignment()
/**
* Synchronizes contact person usernames with the organization entity's users array
* This method finds all contact persons associated with a given organization UUID
* and ensures their emails are present in the organization entity's users array
- *
+ *
* @param string $organizationUuid The UUID of the organization
- *
+ *
* @return void
*/
public function syncContactPersonUsernamesWithOrganization(string $organizationUuid): void
{
- $this->_logger->info('SoftwareCatalogueService: Starting contact person username synchronization', [
- 'organizationUuid' => $organizationUuid
- ]);
-
- // Get the ObjectService to find contact persons
- $objectService = $this->_getObjectService();
- if (!$objectService) {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Starting contact person username synchronization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
+
+ // Get the ObjectService to find contact persons.
+ $objectService = $this->getObjectService();
+ if ($objectService === null) {
$this->_logger->error('SoftwareCatalogueService: ObjectService not available for username synchronization');
return;
}
-
- // Get the contact person schema ID from configuration
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+
+ // Get the contact person schema ID from configuration.
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
$voorzieningenConfig = $settingsService->getVoorzieningenConfig();
- $contactSchemaId = $voorzieningenConfig['contactpersoon_schema'] ?? null;
- $registerId = $voorzieningenConfig['register'] ?? null;
-
- if (!$contactSchemaId || !$registerId) {
- $this->_logger->warning('SoftwareCatalogueService: Missing Voorzieningen configuration for contact person sync', [
- 'organizationUuid' => $organizationUuid,
- 'contactSchemaId' => $contactSchemaId,
- 'registerId' => $registerId
- ]);
+ $contactSchemaId = $voorzieningenConfig['contactpersoon_schema'] ?? null;
+ $registerId = $voorzieningenConfig['register'] ?? null;
+
+ if ($contactSchemaId === null || $registerId === false) {
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Missing Voorzieningen configuration for contact person sync',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'contactSchemaId' => $contactSchemaId,
+ 'registerId' => $registerId,
+ ]
+ );
return;
}
-
+
try {
- // Find all contact persons that have this organization as their organisatie
- $contactPersons = $objectService->findAll([
- 'filters' => [
- 'register' => (string) $registerId,
- 'schema' => $contactSchemaId,
- 'organisatie' => $organizationUuid
- ]
- ]);
-
- $this->_logger->info('SoftwareCatalogueService: Found contact persons for synchronization', [
- 'organizationUuid' => $organizationUuid,
- 'contactPersonCount' => count($contactPersons)
- ]);
-
- // Collect all usernames from contact persons
+ // Find all contact persons that have this organization as their organisatie.
+ $contactPersons = $objectService->findAll(
+ [
+ 'filters' => [
+ 'register' => (string) $registerId,
+ 'schema' => $contactSchemaId,
+ 'organisatie' => $organizationUuid,
+ ],
+ ]
+ );
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Found contact persons for synchronization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'contactPersonCount' => count($contactPersons),
+ ]
+ );
+
+ // Collect all usernames from contact persons.
$contactPersonUsernames = [];
foreach ($contactPersons as $contactPerson) {
$contactData = $contactPerson->getObject();
- $email = $contactData['email'] ?? null;
- if ($email) {
+ $email = $contactData['email'] ?? null;
+ if (empty($email) === false) {
$contactPersonUsernames[] = $email;
- $this->_logger->info('SoftwareCatalogueService: Found contact person username', [
- 'username' => $email,
- 'contactPersonId' => $contactPerson->getId()
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Found contact person username',
+ [
+ 'username' => $email,
+ 'contactPersonId' => $contactPerson->getId(),
+ ]
+ );
}
}
-
- // Get the organization entity
+
+ // Get the organization entity.
$organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
- $organisation = $organisationMapper->findByUuid($organizationUuid);
-
- if (!$organisation) {
- $this->_logger->error('SoftwareCatalogueService: Organization entity not found for synchronization', [
- 'organizationUuid' => $organizationUuid
- ]);
+ $organisation = $organisationMapper->findByUuid($organizationUuid);
+
+ if ($organisation === null) {
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Organization entity not found for synchronization',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return;
}
-
- // Get current users and add contact person usernames
+
+ // Get current users and add contact person usernames.
$currentUsers = $organisation->getUsers() ?? [];
- $allUsers = array_merge($currentUsers, $contactPersonUsernames);
- $allUsers = array_unique($allUsers);
-
- $this->_logger->info('SoftwareCatalogueService: Updating organization entity users', [
- 'organizationUuid' => $organizationUuid,
- 'currentUsers' => $currentUsers,
- 'contactPersonUsernames' => $contactPersonUsernames,
- 'finalUsers' => $allUsers
- ]);
-
- // Update the organization entity
+ $allUsers = array_merge($currentUsers, $contactPersonUsernames);
+ $allUsers = array_unique($allUsers);
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Updating organization entity users',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'currentUsers' => $currentUsers,
+ 'contactPersonUsernames' => $contactPersonUsernames,
+ 'finalUsers' => $allUsers,
+ ]
+ );
+
+ // Update the organization entity.
$organisation->setUsers($allUsers);
$organisationMapper->save($organisation);
-
- $this->_logger->info('SoftwareCatalogueService: Successfully synchronized contact person usernames', [
- 'organizationUuid' => $organizationUuid,
- 'totalUsers' => count($allUsers)
- ]);
-
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully synchronized contact person usernames',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'totalUsers' => count($allUsers),
+ ]
+ );
} catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
- // Organization entity doesn't exist yet - this can happen due to race conditions
- // Log and return gracefully, the organization sync will handle this later
- $this->_logger->warning('SoftwareCatalogueService: Organization entity not found during username sync (race condition)', [
- 'organizationUuid' => $organizationUuid,
- 'message' => 'This is expected during anonymous registration - organization entity is created after contact persons'
- ]);
+ // Organization entity doesn't exist yet - this can happen due to race conditions.
+ // Log and return gracefully, the organization sync will handle this later.
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Organization entity not found during username sync (race condition)',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'message' => 'This is expected during anonymous registration - organization entity is created after contact persons',
+ ]
+ );
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: Error synchronizing contact person usernames', [
- 'organizationUuid' => $organizationUuid,
- 'error' => $e->getMessage(),
- 'trace' => $e->getTraceAsString()
- ]);
- }
- }
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Error synchronizing contact person usernames',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'error' => $e->getMessage(),
+ 'trace' => $e->getTraceAsString(),
+ ]
+ );
+ }//end try
+ }//end syncContactPersonUsernamesWithOrganization()
/**
* Ensures a contact person's username is in their organization's users array
* This method is called when a contact person is created or updated
- *
+ *
* @param object $contactPersonObject The contact person object
- *
+ *
* @return void
*/
public function ensureContactPersonInOrganization(object $contactPersonObject): void
{
$contactData = $contactPersonObject->getObject();
- $email = $contactData['email'] ?? null;
+ $email = $contactData['email'] ?? null;
$organisatie = $contactData['organisatie'] ?? null;
-
- if (!$email || !$organisatie) {
- $this->_logger->info('SoftwareCatalogueService: Contact person missing email or organisation', [
- 'contactPersonId' => $contactPersonObject->getId(),
- 'hasEmail' => !empty($email),
- 'hasOrganisatie' => !empty($organisatie)
- ]);
+
+ if ($email === null || $organisatie === false) {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Contact person missing email or organisation',
+ [
+ 'contactPersonId' => $contactPersonObject->getId(),
+ 'hasEmail' => empty($email) === false,
+ 'hasOrganisatie' => empty($organisatie) === false,
+ ]
+ );
return;
}
-
- // Skip if the contact person is owned by the default organization
+
+ // Skip if the contact person is owned by the default organization.
$owner = $contactPersonObject->getOwner();
if ($owner === 'system') {
- $this->_logger->info('SoftwareCatalogueService: Skipping contact person owned by system', [
- 'contactPersonId' => $contactPersonObject->getId(),
- 'username' => $email
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Skipping contact person owned by system',
+ [
+ 'contactPersonId' => $contactPersonObject->getId(),
+ 'username' => $email,
+ ]
+ );
return;
}
-
- $this->_logger->info('SoftwareCatalogueService: Ensuring contact person in organization', [
- 'contactPersonId' => $contactPersonObject->getId(),
- 'username' => $email,
- 'organisatie' => $organisatie
- ]);
-
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Ensuring contact person in organization',
+ [
+ 'contactPersonId' => $contactPersonObject->getId(),
+ 'username' => $email,
+ 'organisatie' => $organisatie,
+ ]
+ );
+
try {
- // Get the organization entity
+ // Get the organization entity.
$organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
- $organisation = $organisationMapper->findByUuid($organisatie);
-
- if (!$organisation) {
- $this->_logger->error('SoftwareCatalogueService: Organization entity not found for contact person', [
- 'contactPersonId' => $contactPersonObject->getId(),
- 'organisatie' => $organisatie
- ]);
+ $organisation = $organisationMapper->findByUuid($organisatie);
+
+ if ($organisation === null) {
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Organization entity not found for contact person',
+ [
+ 'contactPersonId' => $contactPersonObject->getId(),
+ 'organisatie' => $organisatie,
+ ]
+ );
return;
}
-
- // Check if the username is already in the organization's users array
+
+ // Check if the username is already in the organization's users array.
$currentUsers = $organisation->getUsers() ?? [];
- if (in_array($email, $currentUsers)) {
- $this->_logger->info('SoftwareCatalogueService: Contact person already in organization', [
- 'contactPersonId' => $contactPersonObject->getId(),
- 'username' => $email,
- 'organisatie' => $organisatie
- ]);
+ if (in_array($email, $currentUsers) === true) {
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Contact person already in organization',
+ [
+ 'contactPersonId' => $contactPersonObject->getId(),
+ 'username' => $email,
+ 'organisatie' => $organisatie,
+ ]
+ );
return;
}
-
- // Add the username to the organization's users array
+
+ // Add the username to the organization's users array.
$currentUsers[] = $email;
$organisation->setUsers($currentUsers);
$organisationMapper->save($organisation);
-
- $this->_logger->info('SoftwareCatalogueService: Successfully added contact person to organization', [
- 'contactPersonId' => $contactPersonObject->getId(),
- 'username' => $email,
- 'organisatie' => $organisatie,
- 'totalUsers' => count($currentUsers)
- ]);
-
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully added contact person to organization',
+ [
+ 'contactPersonId' => $contactPersonObject->getId(),
+ 'username' => $email,
+ 'organisatie' => $organisatie,
+ 'totalUsers' => count($currentUsers),
+ ]
+ );
} catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
- // Organization entity doesn't exist yet - this can happen due to race conditions
- // Log and return gracefully, the organization sync will handle this later
- $this->_logger->warning('SoftwareCatalogueService: Organization entity not found (race condition), will be handled by organization sync', [
- 'contactPersonId' => $contactPersonObject->getId(),
- 'username' => $email,
- 'organisatie' => $organisatie,
- 'message' => 'This is expected during anonymous registration - organization entity is created after contact persons'
- ]);
+ // Organization entity doesn't exist yet - this can happen due to race conditions.
+ // Log and return gracefully, the organization sync will handle this later.
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Organization entity not found (race condition), will be handled by organization sync',
+ [
+ 'contactPersonId' => $contactPersonObject->getId(),
+ 'username' => $email,
+ 'organisatie' => $organisatie,
+ 'message' => 'This is expected during anonymous registration - organization entity is created after contact persons',
+ ]
+ );
return;
- }
- }
+ }//end try
+ }//end ensureContactPersonInOrganization()
/**
* Updates organization references on objects to point to the newly created organization entity
- *
+ *
* @param object $organizationObject The organization object
- *
+ *
* @return void
*/
private function updateOrganizationReferences(object $organizationObject): void
{
try {
- $this->_logger->info('SoftwareCatalogueService: Updating organization references', [
- 'objectId' => $organizationObject->getId()
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Updating organization references',
+ [
+ 'objectId' => $organizationObject->getId(),
+ ]
+ );
- $objectData = $organizationObject->getObject();
+ $objectData = $organizationObject->getObject();
$organizationUuid = $objectData['id'] ?? $organizationObject->getId();
- // Get the ObjectService to update objects
- $objectService = $this->_getObjectService();
- if (!$objectService) {
+ // Get the ObjectService to update objects.
+ $objectService = $this->getObjectService();
+ if ($objectService === null) {
$this->_logger->error('SoftwareCatalogueService: ObjectService not available for updating references');
return;
}
- // Get the organization entity UUID (should be the same as the organization object UUID)
+ // Get the organization entity UUID (should be the same as the organization object UUID).
$organisationMapper = $this->_container->get('OCA\\OpenRegister\\Db\\OrganisationMapper');
try {
- // Use the original UUID format for OpenRegister lookup
- $organisationEntity = $organisationMapper->findByUuid($organizationUuid);
+ // Use the original UUID format for OpenRegister lookup.
+ $organisationEntity = $organisationMapper->findByUuid($organizationUuid);
$organisationEntityUuid = $organisationEntity->getUuid();
-
- $this->_logger->info('SoftwareCatalogueService: Found organization entity for reference update', [
- 'organizationObjectUuid' => $organizationUuid,
- 'organizationEntityUuid' => $organisationEntityUuid
- ]);
+
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Found organization entity for reference update',
+ [
+ 'organizationObjectUuid' => $organizationUuid,
+ 'organizationEntityUuid' => $organisationEntityUuid,
+ ]
+ );
} catch (\OCP\AppFramework\Db\DoesNotExistException $e) {
- $this->_logger->error('SoftwareCatalogueService: Organization entity not found for reference update', [
- 'organizationUuid' => $organizationUuid
- ]);
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Organization entity not found for reference update',
+ [
+ 'organizationUuid' => $organizationUuid,
+ ]
+ );
return;
- }
+ }//end try
- // Update the organization object's @self.organisation field
- $this->_logger->info('SoftwareCatalogueService: Updating organization object reference', [
- 'objectId' => $organizationObject->getId(),
- 'newOrganisationUuid' => $organisationEntityUuid
- ]);
+ // Update the organization object's @self.organisation field.
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Updating organization object reference',
+ [
+ 'objectId' => $organizationObject->getId(),
+ 'newOrganisationUuid' => $organisationEntityUuid,
+ ]
+ );
- // Get the current object data and update the organisation field
+ // Get the current object data and update the organisation field.
$currentObjectData = $organizationObject->getObject();
$currentObjectData['@self']['organisation'] = $organisationEntityUuid;
-
- // Update the organization object using the ObjectService
+
+ // Update the organization object using the ObjectService.
+ // Don't update version, not a patch, no extend.
$objectService->updateFromArray(
$organizationObject->getId(),
$currentObjectData,
- false, // don't update version
- false, // not a patch
- [], // no extend
+ false,
+ false,
+ [],
$organizationObject->getRegisterId(),
$organizationObject->getSchemaId()
);
- // Update contact person objects' @self.organisatie field
+ // Update contact person objects' @self.organisatie field.
$contactpersonen = $objectData['contactpersonen'] ?? [];
foreach ($contactpersonen as $contactUuid) {
- $this->_logger->info('SoftwareCatalogueService: Updating contact person object reference', [
- 'contactUuid' => $contactUuid,
- 'newOrganisationUuid' => $organisationEntityUuid
- ]);
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Updating contact person object reference',
+ [
+ 'contactUuid' => $contactUuid,
+ 'newOrganisationUuid' => $organisationEntityUuid,
+ ]
+ );
- // Get the contact person schema ID from configuration
- $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
+ // Get the contact person schema ID from configuration.
+ $settingsService = $this->_container->get('OCA\SoftwareCatalog\Service\SettingsService');
$voorzieningenConfig = $settingsService->getVoorzieningenConfig();
- $contactSchemaId = $voorzieningenConfig['contactpersoon_schema'] ?? null;
-
- if (!$contactSchemaId) {
- $this->_logger->warning('SoftwareCatalogueService: Missing contactpersoon schema configuration for object update', [
- 'contactUuid' => $contactUuid
- ]);
+ $contactSchemaId = $voorzieningenConfig['contactpersoon_schema'] ?? null;
+
+ if ($contactSchemaId === null) {
+ $this->_logger->warning(
+ 'SoftwareCatalogueService: Missing contactpersoon schema configuration for object update',
+ [
+ 'contactUuid' => $contactUuid,
+ ]
+ );
continue;
}
- // Find the contact person object
+ // Find the contact person object.
try {
$contactObject = $objectService->find($contactUuid, [], false, $organizationObject->getRegisterId(), $contactSchemaId);
- if ($contactObject) {
- // Get the current object data and update the organisatie field
+ if (empty($contactObject) === false) {
+ // Get the current object data and update the organisatie field.
$contactObjectData = $contactObject->getObject();
$contactObjectData['@self']['organisatie'] = $organisationEntityUuid;
-
- // Update the contact person object using the ObjectService
+
+ // Update the contact person object using the ObjectService.
+ // Don't update version, not a patch, no extend.
$objectService->updateFromArray(
$contactObject->getId(),
$contactObjectData,
- false, // don't update version
- false, // not a patch
- [], // no extend
+ false,
+ false,
+ [],
$organizationObject->getRegisterId(),
$contactSchemaId
);
}
} catch (\Exception $e) {
- $this->_logger->error('SoftwareCatalogueService: Failed to update contact person object', [
- 'contactUuid' => $contactUuid,
- 'error' => $e->getMessage()
- ]);
- }
- }
-
- $this->_logger->info('SoftwareCatalogueService: Successfully updated organization references', [
- 'organizationUuid' => $organizationUuid,
- 'organizationEntityUuid' => $organisationEntityUuid,
- 'contactPersonCount' => count($contactpersonen)
- ]);
+ $this->_logger->error(
+ 'SoftwareCatalogueService: Failed to update contact person object',
+ [
+ 'contactUuid' => $contactUuid,
+ 'error' => $e->getMessage(),
+ ]
+ );
+ }//end try
+ }//end foreach
+ $this->_logger->info(
+ 'SoftwareCatalogueService: Successfully updated organization references',
+ [
+ 'organizationUuid' => $organizationUuid,
+ 'organizationEntityUuid' => $organisationEntityUuid,
+ 'contactPersonCount' => count($contactpersonen),
+ ]
+ );
} catch (\Exception $e) {
$this->_logger->error(
- 'SoftwareCatalogueService: Failed to update organization references: ' . $e->getMessage(),
+ 'SoftwareCatalogueService: Failed to update organization references: '.$e->getMessage(),
[
- 'objectId' => $organizationObject->getId(),
+ 'objectId' => $organizationObject->getId(),
'exception' => $e->getMessage(),
- 'file' => $e->getFile(),
- 'line' => $e->getLine(),
- 'trace' => $e->getTraceAsString()
+ 'file' => $e->getFile(),
+ 'line' => $e->getLine(),
+ 'trace' => $e->getTraceAsString(),
]
);
- }
- }
-
-}
\ No newline at end of file
+ }//end try
+ }//end updateOrganizationReferences()
+}//end class
diff --git a/lib/Service/SymfonyEmailService.php b/lib/Service/SymfonyEmailService.php
index 20012d78..62d9dc07 100644
--- a/lib/Service/SymfonyEmailService.php
+++ b/lib/Service/SymfonyEmailService.php
@@ -1,5 +1,17 @@
+ * @copyright 2024 Conduction B.V.
+ * @license EUPL-1.2 https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12
+ * @version GIT:
+ * @link https://github.com/ConductionNL/SoftwareCatalog
+ */
+
declare(strict_types=1);
namespace OCA\SoftwareCatalog\Service;
@@ -26,7 +38,7 @@
* @author Conduction b.v.
* @license AGPL-3.0-or-later https://www.gnu.org/licenses/agpl-3.0.html
* @link https://github.com/ConductionNL/SoftwareCatalog
- * @version 1.0.0
+ * @version GIT:
*/
class SymfonyEmailService
{
@@ -102,7 +114,8 @@ class SymfonyEmailService
Welkom {{ user.name }}!
Beste {{ user.name }},
- Hartelijk welkom bij de Software Catalogus! Uw gebruikersaccount is succesvol aangemaakt voor {{ organization.name }}.
+ Hartelijk welkom bij de Software Catalogus! Uw gebruikersaccount is
+ succesvol aangemaakt voor {{ organization.name }}.
U kunt nu:
- Inloggen op het platform
@@ -142,7 +155,8 @@ class SymfonyEmailService
- Tijdelijk wachtwoord:
{{ user.password }}
Belangrijk: We raden u aan om dit tijdelijke wachtwoord te wijzigen na uw eerste inlog.
- U kunt inloggen op het platform en direct aan de slag met het beheren van software voor {{ organization.name }}.
+ U kunt inloggen op het platform en direct aan de slag met het beheren
+ van software voor {{ organization.name }}.
Heeft u vragen? Neem dan contact met ons op via info@conduction.nl
Met vriendelijke groet,
Het Software Catalogus Team
@@ -172,7 +186,8 @@ class SymfonyEmailService
Samenwerken met andere organisaties
Login gegevens:
- We hebben uw bestaande account gekoppeld aan een nieuwe organisatie. Uw inloggegevens zijn hetzelfde, maar u kunt nu uw organisatie wisselen tussen uw organisaties.
+ We hebben uw bestaande account gekoppeld aan een nieuwe organisatie.
+ Uw inloggegevens zijn hetzelfde, maar u kunt nu uw organisatie wisselen tussen uw organisaties.
Heeft u vragen? Neem dan contact met ons op via info@conduction.nl
Met vriendelijke groet,
Het Software Catalogus Team
+
