Skip to content

refactor: Port CircleInvitation to ORM system #2940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CarlSchwan merged 1 commit into from
Oct 6, 2026
Merged

refactor: Port CircleInvitation to ORM system #2940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 0 additions & 54 deletions lib/Db/CircleInvitationRequest.php
View file
Open in desktop

This file was deleted.

53 changes: 53 additions & 0 deletions lib/Entity/CircleInvitation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<?php

declare(strict_types=1);

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

namespace OCA\Circles\Entity;

use DateTime;
use DateTimeZone;
use JsonSerializable;
use OCP\AppFramework\ORM\Attribute\Column;
use OCP\AppFramework\ORM\Attribute\Entity;
use OCP\AppFramework\ORM\Attribute\Id;
use OCP\DB\Schema\ColumnType;

/**
* A pending invitation to join a circle, identified by its own invitation code.
*/
#[Entity(name: 'circles_invitations')]
final class CircleInvitation implements JsonSerializable {
#[Id]
#[Column(name: 'id', type: ColumnType::Integer)]
public ?int $id = null;

#[Column(name: 'circle_id', type: ColumnType::String, length: 32)]
public string $circleId = '';

#[Column(name: 'invitation_code', type: ColumnType::String, length: 16)]
public string $invitationCode = '';

#[Column(name: 'created_by', type: ColumnType::String, length: 255)]
public string $createdBy = '';

#[Column(name: 'created', type: ColumnType::Datetime)]
public DateTime $created;

public function __construct() {
$this->created = new DateTime('now', new DateTimeZone('UTC'));
}

public function jsonSerialize(): array {
return [
'circleId' => $this->circleId,
'invitationCode' => $this->invitationCode,
'createdBy' => $this->createdBy,
'created' => $this->created->getTimestamp(),
];
}
}
13 changes: 0 additions & 13 deletions lib/Exceptions/CircleInvitationNotFoundException.php
View file
Open in desktop

This file was deleted.

14 changes: 7 additions & 7 deletions lib/FederatedItems/CircleCreateInvitation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@

namespace OCA\Circles\FederatedItems;

use OCA\Circles\Db\CircleInvitationRequest;
use OCA\Circles\Entity\CircleInvitation;
use OCA\Circles\IFederatedItem;
use OCA\Circles\Model\CircleInvitation;
use OCA\Circles\Model\Federated\FederatedEvent;
use OCA\Circles\Model\Helpers\MemberHelper;
use OCA\Circles\Repository\CircleInvitationRepository;
use OCA\Circles\Service\EventService;
use OCA\Circles\Tools\Traits\TDeserialize;
use OCP\Security\ISecureRandom;
Expand All @@ -23,7 +23,7 @@ class CircleCreateInvitation implements IFederatedItem {
use TDeserialize;

public function __construct(
private CircleInvitationRequest $circleInvitationRequest,
private CircleInvitationRepository $circleInvitationRepository,
private EventService $eventService,
) {
}
Expand All @@ -39,9 +39,9 @@ public function verify(FederatedEvent $event): void {
$invitationCode = (new Randomizer())->getBytesFromString(ISecureRandom::CHAR_HUMAN_READABLE, 16);

$circleInvitation = new CircleInvitation();
$circleInvitation->setCircleId($circle->getSingleId());
$circleInvitation->setInvitationCode($invitationCode);
$circleInvitation->setCreatedBy($circle->getInitiator()->getUserId());
$circleInvitation->circleId = $circle->getSingleId();
$circleInvitation->invitationCode = $invitationCode;
$circleInvitation->createdBy = $circle->getInitiator()->getUserId();

$new->setCircleInvitation($circleInvitation);
$event->getData()->sObj('circle_invitation', $circleInvitation);
Expand All @@ -52,7 +52,7 @@ public function verify(FederatedEvent $event): void {
public function manage(FederatedEvent $event): void {
/** @var CircleInvitation $circleInvitation */
$circleInvitation = $event->getData()->gObj('circle_invitation');
$this->circleInvitationRequest->replace($circleInvitation);
$this->circleInvitationRepository->replace($circleInvitation);

// todo: do we need separate event here?
$this->eventService->circleEditing($event);
Expand Down
2 changes: 1 addition & 1 deletion lib/FederatedItems/CircleJoin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ private function manageMemberStatus(Circle $circle, Member $member, ?string $inv

throw new MemberAlreadyExistsException(StatusCode::$CIRCLE_JOIN[122], 122);
} catch (MemberNotFoundException) {
$allowedToJoin = $invitationCode && $circle->getCircleInvitation()?->getInvitationCode() === $invitationCode;
$allowedToJoin = $invitationCode && $circle->getCircleInvitation()?->invitationCode === $invitationCode;
if (!$circle->isConfig(Circle::CFG_OPEN) && !$allowedToJoin) {
throw new FederatedItemBadRequestException(StatusCode::$CIRCLE_JOIN[124], 124);
}
Expand Down
6 changes: 3 additions & 3 deletions lib/FederatedItems/CircleRevokeInvitation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@

namespace OCA\Circles\FederatedItems;

use OCA\Circles\Db\CircleInvitationRequest;
use OCA\Circles\IFederatedItem;
use OCA\Circles\Model\Federated\FederatedEvent;
use OCA\Circles\Model\Helpers\MemberHelper;
use OCA\Circles\Repository\CircleInvitationRepository;
use OCA\Circles\Service\EventService;
use OCA\Circles\Tools\Traits\TDeserialize;

class CircleRevokeInvitation implements IFederatedItem {
use TDeserialize;

public function __construct(
private CircleInvitationRequest $circleInvitationRequest,
private CircleInvitationRepository $circleInvitationRepository,
private EventService $eventService,
) {
}
Expand All @@ -40,7 +40,7 @@ public function verify(FederatedEvent $event): void {
public function manage(FederatedEvent $event): void {
$circle = clone $event->getCircle();

$this->circleInvitationRequest->delete($circle->getSingleId());
$this->circleInvitationRepository->deleteBy(['circleId' => $circle->getSingleId()]);
// todo: do we need separate event here?
$this->eventService->circleEditing($event);
}
Expand Down
14 changes: 9 additions & 5 deletions lib/Model/Circle.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use DateTime;
use JsonSerializable;
use OCA\Circles\Db\CircleRequest;
use OCA\Circles\Entity\CircleInvitation;
use OCA\Circles\Exceptions\CircleNotFoundException;
use OCA\Circles\Exceptions\FederatedItemException;
use OCA\Circles\Exceptions\MemberHelperException;
Expand Down Expand Up @@ -803,11 +804,14 @@ public function import(array $data): IDeserializable {
} catch (InvalidItemException) {
}

try {
/** @var CircleInvitation $circleInvitation */
$circleInvitation = $this->deserialize($this->getArray('invitation', $data), CircleInvitation::class);
$invitationData = $this->getArray('invitation', $data);
if ($this->get('circleId', $invitationData) !== '') {
$circleInvitation = new CircleInvitation();
$circleInvitation->circleId = $this->get('circleId', $invitationData);
$circleInvitation->invitationCode = $this->get('invitationCode', $invitationData);
$circleInvitation->createdBy = $this->get('createdBy', $invitationData);
$circleInvitation->created->setTimestamp($this->getInt('created', $invitationData));
$this->setCircleInvitation($circleInvitation);
} catch (InvalidItemException $e) {
}

return $this;
Expand Down Expand Up @@ -860,7 +864,7 @@ public function jsonSerialize(): array {
try {
$initiatorHelper->mustBeAdmin();
$arr['settings'] = $this->getSettings();
$arr['invitationCode'] = $this->getCircleInvitation()?->getInvitationCode();
$arr['invitationCode'] = $this->getCircleInvitation()?->invitationCode;
} catch (MemberHelperException|MemberLevelException) {
}
}
Expand Down
108 changes: 0 additions & 108 deletions lib/Model/CircleInvitation.php
View file
Open in desktop

This file was deleted.

24 changes: 12 additions & 12 deletions lib/Model/ModelManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
use OCA\Circles\Db\CoreQueryBuilder;
use OCA\Circles\Db\MemberRequest;
use OCA\Circles\Db\MembershipRequest;
use OCA\Circles\Entity\CircleInvitation;
use OCA\Circles\Entity\ShareToken;
use OCA\Circles\Exceptions\CircleInvitationNotFoundException;
use OCA\Circles\Exceptions\CircleNotFoundException;
use OCA\Circles\Exceptions\FederatedItemException;
use OCA\Circles\Exceptions\FederatedUserNotFoundException;
Expand Down Expand Up @@ -172,12 +172,6 @@ public function manageImportFromDatabase(ManagedModel $model, array $data, strin
}
}

if ($model instanceof CircleInvitation) {
if ($base === '') {
$base = CoreQueryBuilder::INVITATION;
}
}

if ($model instanceof Member) {
if ($base === '') {
$base = CoreQueryBuilder::MEMBER;
Expand Down Expand Up @@ -258,12 +252,18 @@ private function importIntoCircle(Circle $circle, array $data, string $path, str
}
break;
case CoreQueryBuilder::INVITATION:
try {
$circleInvitation = new CircleInvitation();
$circleInvitation->importFromDatabase($data, $prefix);
$circle->setCircleInvitation($circleInvitation);
} catch (CircleInvitationNotFoundException $e) {
if (($data[$prefix . 'circle_id'] ?? '') === '') {
break;
}

$circleInvitation = new CircleInvitation();
$circleInvitation->circleId = $data[$prefix . 'circle_id'] ?? '';
$circleInvitation->invitationCode = $data[$prefix . 'invitation_code'] ?? '';
$circleInvitation->createdBy = $data[$prefix . 'created_by'] ?? '';
$circleInvitation->created = \DateTime::createFromFormat('Y-m-d H:i:s', $data[$prefix . 'created'] ?? '')
?: new \DateTime((string)($data[$prefix . 'created'] ?? ''));

$circle->setCircleInvitation($circleInvitation);
break;
}
}
Expand Down
Loading
Loading