Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/build-artifact.yml
Original file line number Diff line number Diff line change
Expand Up @@ -656,6 +656,15 @@ jobs:
- name: Add config partials
run: make -f IONOS/Makefile add_config_partials

# IONOS Customization: Inject build number for production traceability
# This is specific to IONOS Nextcloud Workspace and not part of upstream Nextcloud
- name: Inject build number
run: |
echo "${{ github.run_number }}" > .buildnumber
echo "✅ Build number injected: ${{ github.run_number }}"
echo "📄 File created: .buildnumber"
cat .buildnumber

- name: Zip dependencies
run: make -f IONOS/Makefile zip_dependencies TARGET_PACKAGE_NAME=${{ env.TARGET_PACKAGE_NAME }}

Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
/translationfiles
/translationtool.phar

# CI/CD generated files
/.buildnumber

# ignore all apps except core ones
/apps*/*
!/apps/cloud_federation_api
Expand Down
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,6 @@
[submodule "apps-external/twofactor_totp"]
path = apps-external/twofactor_totp
url = git@github.com:nextcloud/twofactor_totp.git
[submodule "apps-external/ncw_tools"]
path = apps-external/ncw_tools
url = git@github.com:IONOS-Productivity/ncw-tools.git
2 changes: 1 addition & 1 deletion IONOS
Submodule IONOS updated 2 files
+15 −0 Makefile
+1 −0 always-enabled-apps.list
1 change: 1 addition & 0 deletions apps-external/ncw_tools
Submodule ncw_tools added at 001285
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -606,6 +606,7 @@
'OCP\\IUserManager' => $baseDir . '/lib/public/IUserManager.php',
'OCP\\IUserSession' => $baseDir . '/lib/public/IUserSession.php',
'OCP\\Image' => $baseDir . '/lib/public/Image.php',
'OCP\\Install\\Events\\InstallationCompletedEvent' => $baseDir . '/lib/public/Install/Events/InstallationCompletedEvent.php',
'OCP\\L10N\\IFactory' => $baseDir . '/lib/public/L10N/IFactory.php',
'OCP\\L10N\\ILanguageIterator' => $baseDir . '/lib/public/L10N/ILanguageIterator.php',
'OCP\\LDAP\\IDeletionFlagSupport' => $baseDir . '/lib/public/LDAP/IDeletionFlagSupport.php',
Expand Down
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -655,6 +655,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OCP\\IUserManager' => __DIR__ . '/../../..' . '/lib/public/IUserManager.php',
'OCP\\IUserSession' => __DIR__ . '/../../..' . '/lib/public/IUserSession.php',
'OCP\\Image' => __DIR__ . '/../../..' . '/lib/public/Image.php',
'OCP\\Install\\Events\\InstallationCompletedEvent' => __DIR__ . '/../../..' . '/lib/public/Install/Events/InstallationCompletedEvent.php',
'OCP\\L10N\\IFactory' => __DIR__ . '/../../..' . '/lib/public/L10N/IFactory.php',
'OCP\\L10N\\ILanguageIterator' => __DIR__ . '/../../..' . '/lib/public/L10N/ILanguageIterator.php',
'OCP\\LDAP\\IDeletionFlagSupport' => __DIR__ . '/../../..' . '/lib/public/LDAP/IDeletionFlagSupport.php',
Expand Down
10 changes: 10 additions & 0 deletions lib/private/Setup.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,13 @@
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\BackgroundJob\IJobList;
use OCP\Defaults;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IAppConfig;
use OCP\IConfig;
use OCP\IGroup;
use OCP\IGroupManager;
use OCP\IL10N;
use OCP\Install\Events\InstallationCompletedEvent;
use OCP\IRequest;
use OCP\IUserManager;
use OCP\IUserSession;
Expand All @@ -48,6 +50,7 @@ public function __construct(
protected LoggerInterface $logger,
protected ISecureRandom $random,
protected Installer $installer,
protected IEventDispatcher $eventDispatcher,
) {
$this->l10n = $l10nFactory->get('lib');
}
Expand Down Expand Up @@ -408,6 +411,13 @@ public function install(array $options, ?IOutput $output = null): array {
$user->setSystemEMailAddress($options['adminemail']);
}

// Dispatch installation completed event
$adminUsername = !empty($username) ? $username : null;
$adminEmail = !empty($options['adminemail']) ? $options['adminemail'] : null;
$this->eventDispatcher->dispatchTyped(
new InstallationCompletedEvent($dataDir, $adminUsername, $adminEmail)
);

return $error;
}

Expand Down
79 changes: 79 additions & 0 deletions lib/public/Install/Events/InstallationCompletedEvent.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Install\Events;

use OCP\EventDispatcher\Event;

/**
* Emitted when the Nextcloud installation has been completed successfully.
*
* This event is dispatched after:
* - The database has been configured and migrations have run
* - The admin user has been created (if applicable)
* - Default apps have been installed
* - Background jobs have been configured
* - The system has been marked as installed
*
* Apps can listen to this event to perform additional actions after installation,
* such as:
* - Sending notification emails
* - Triggering external APIs
* - Initializing app-specific data
* - Setting up integrations
*
* @since 33.0.0
*/
class InstallationCompletedEvent extends Event {
/**
* @since 33.0.0
*/
public function __construct(
private string $dataDirectory,
private ?string $adminUsername = null,
private ?string $adminEmail = null,
) {
parent::__construct();
}

/**
* Get the configured data directory path
*
* @since 33.0.0
*/
public function getDataDirectory(): string {
return $this->dataDirectory;
}

/**
* Get the admin username if an admin user was created
*
* @since 33.0.0
*/
public function getAdminUsername(): ?string {
return $this->adminUsername;
}

/**
* Get the admin email if configured
*
* @since 33.0.0
*/
public function getAdminEmail(): ?string {
return $this->adminEmail;
}

/**
* Check if an admin user was created during installation
*
* @since 33.0.0
*/
public function hasAdminUser(): bool {
return $this->adminUsername !== null;
}
}
89 changes: 89 additions & 0 deletions tests/lib/Install/Events/InstallationCompletedEventTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace Test\Install\Events;

use OCP\Install\Events\InstallationCompletedEvent;

class InstallationCompletedEventTest extends \Test\TestCase {
public function testConstructorWithAllParameters(): void {
$dataDir = '/path/to/data';
$adminUsername = 'admin';
$adminEmail = 'admin@example.com';

$event = new InstallationCompletedEvent($dataDir, $adminUsername, $adminEmail);

$this->assertEquals($dataDir, $event->getDataDirectory());
$this->assertEquals($adminUsername, $event->getAdminUsername());
$this->assertEquals($adminEmail, $event->getAdminEmail());
$this->assertTrue($event->hasAdminUser());
}

public function testConstructorWithMinimalParameters(): void {
$dataDir = '/path/to/data';

$event = new InstallationCompletedEvent($dataDir);

$this->assertEquals($dataDir, $event->getDataDirectory());
$this->assertNull($event->getAdminUsername());
$this->assertNull($event->getAdminEmail());
$this->assertFalse($event->hasAdminUser());
}

public function testConstructorWithUsernameOnly(): void {
$dataDir = '/path/to/data';
$adminUsername = 'admin';

$event = new InstallationCompletedEvent($dataDir, $adminUsername);

$this->assertEquals($dataDir, $event->getDataDirectory());
$this->assertEquals($adminUsername, $event->getAdminUsername());
$this->assertNull($event->getAdminEmail());
$this->assertTrue($event->hasAdminUser());
}

public function testConstructorWithUsernameAndEmail(): void {
$dataDir = '/path/to/data';
$adminUsername = 'admin';
$adminEmail = 'admin@example.com';

$event = new InstallationCompletedEvent($dataDir, $adminUsername, $adminEmail);

$this->assertEquals($dataDir, $event->getDataDirectory());
$this->assertEquals($adminUsername, $event->getAdminUsername());
$this->assertEquals($adminEmail, $event->getAdminEmail());
$this->assertTrue($event->hasAdminUser());
}

public function testHasAdminUserReturnsFalseWhenUsernameIsNull(): void {
$event = new InstallationCompletedEvent('/path/to/data', null, 'admin@example.com');

$this->assertFalse($event->hasAdminUser());
$this->assertNull($event->getAdminUsername());
$this->assertEquals('admin@example.com', $event->getAdminEmail());
}

public function testDataDirectoryCanBeAnyString(): void {
$customPath = '/custom/data/directory';
$event = new InstallationCompletedEvent($customPath);

$this->assertEquals($customPath, $event->getDataDirectory());
}

public function testEmailCanBeSetWithoutUsername(): void {
$dataDir = '/path/to/data';
$email = 'admin@example.com';

$event = new InstallationCompletedEvent($dataDir, null, $email);

$this->assertNull($event->getAdminUsername());
$this->assertEquals($email, $event->getAdminEmail());
$this->assertFalse($event->hasAdminUser());
}
}
5 changes: 4 additions & 1 deletion tests/lib/SetupTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use OC\Setup;
use OC\SystemConfig;
use OCP\Defaults;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IL10N;
use OCP\L10N\IFactory as IL10NFactory;
use OCP\Security\ISecureRandom;
Expand All @@ -27,6 +28,7 @@ class SetupTest extends \Test\TestCase {
protected LoggerInterface $logger;
protected ISecureRandom $random;
protected Installer $installer;
protected IEventDispatcher $eventDispatcher;

protected function setUp(): void {
parent::setUp();
Expand All @@ -41,9 +43,10 @@ protected function setUp(): void {
$this->logger = $this->createMock(LoggerInterface::class);
$this->random = $this->createMock(ISecureRandom::class);
$this->installer = $this->createMock(Installer::class);
$this->eventDispatcher = $this->createMock(IEventDispatcher::class);
$this->setupClass = $this->getMockBuilder(Setup::class)
->setMethods(['class_exists', 'is_callable', 'getAvailableDbDriversForPdo'])
->setConstructorArgs([$this->config, $this->iniWrapper, $this->l10nFactory, $this->defaults, $this->logger, $this->random, $this->installer])
->setConstructorArgs([$this->config, $this->iniWrapper, $this->l10nFactory, $this->defaults, $this->logger, $this->random, $this->installer, $this->eventDispatcher])
->getMock();
}

Expand Down
48 changes: 48 additions & 0 deletions version.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,51 @@

// Vendor of this package
$vendor = 'nextcloud';

// ============================================================================
// CI/CD Build Number Injection (IONOS Nextcloud Workspace)
// ============================================================================
// Injects a 5th element into the $OC_Version array from the .buildnumber file.
// This file is automatically created by the CI/CD pipeline (build-artifact.yml)
// and contains the GitHub workflow run ID for traceability.
//
// NOTE: This is an IONOS-specific customization for Nextcloud Workspace.
// It is not part of upstream Nextcloud and is used for tracking
// IONOS Nextcloud Workspace builds in production environments.
//
// @since 31.0.8
//
// Purpose:
// - Track which specific CI/CD run produced this artifact
// - Enable direct linking to workflow logs and build details
// - Distinguish between different builds of the same version
// - Support debugging by identifying exact build in production
//
// File Format:
// .buildnumber - Single line containing an integer (GitHub run ID)
// Example: 12345678901
//
// Result:
// Without .buildnumber: $OC_Version = [31, 0, 8, 1]
// With .buildnumber: $OC_Version = [31, 0, 8, 1, 12345678901]
//
// Accessed via:
// - ServerVersion::getBuildId() -> 12345678901
// - ServerVersion::getHumanVersion() -> "31.0.8 (12345678901)"
// - ServerVersion::getVersion() -> [31, 0, 8, 1, 12345678901]
//
// Workflow URL Construction:
// https://github.com/{org}/{repo}/actions/runs/{buildId}
//
// ============================================================================
$buildNumberFile = __DIR__ . '/.buildnumber';
if (file_exists($buildNumberFile)) {
$buildNumberContent = @file_get_contents($buildNumberFile);
if ($buildNumberContent !== false) {
$buildId = (int)trim($buildNumberContent);
if ($buildId > 0) {
// Append build ID as 5th element in version array
$OC_Version[] = $buildId;
}
}
}
Loading