Skip to content
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.

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

ocs endpoint /memberships #966

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
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
2 changes: 2 additions & 0 deletions appinfo/routes.php
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
],
['name' => 'Local#circleJoin', 'url' => '/circles/{circleId}/join', 'verb' => 'PUT'],
['name' => 'Local#circleLeave', 'url' => '/circles/{circleId}/leave', 'verb' => 'PUT'],
['name' => 'Local#memberships', 'url' => '/memberships', 'verb' => 'GET'],

['name' => 'Local#editName', 'url' => '/circles/{circleId}/name', 'verb' => 'PUT'],
['name' => 'Local#editDescription', 'url' => '/circles/{circleId}/description', 'verb' => 'PUT'],
Expand Down Expand Up @@ -93,6 +94,7 @@
],
['name' => 'Admin#circleJoin', 'url' => '/admin/{emulated}/circles/{circleId}/join', 'verb' => 'PUT'],
['name' => 'Admin#circleLeave', 'url' => '/admin/{emulated}/circles/{circleId}/leave', 'verb' => 'PUT'],
['name' => 'Admin#memberships', 'url' => '/admin/{emulated}/memberships', 'verb' => 'GET'],
['name' => 'Admin#editName', 'url' => '/admin/{emulated}/circles/{circleId}/name', 'verb' => 'PUT'],
['name' => 'Admin#editDescription', 'url' => '/admin/{emulated}/circles/{circleId}/description', 'verb' => 'PUT'],
['name' => 'Admin#editSetting', 'url' => '/admin/{emulated}/circles/{circleId}/setting', 'verb' => 'PUT'],
Expand Down
69 changes: 53 additions & 16 deletions lib/Controller/AdminController.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@

namespace OCA\Circles\Controller;

use OCA\Circles\Tools\Traits\TDeserialize;
use OCA\Circles\Tools\Traits\TNCLogger;
use Exception;
use OCA\Circles\Exceptions\ContactAddressBookNotFoundException;
use OCA\Circles\Exceptions\ContactFormatException;
Expand All @@ -46,12 +44,15 @@
use OCA\Circles\Model\Member;
use OCA\Circles\Model\Probes\BasicProbe;
use OCA\Circles\Model\Probes\CircleProbe;
use OCA\Circles\Model\Probes\MemberProbe;
use OCA\Circles\Service\CircleService;
use OCA\Circles\Service\ConfigService;
use OCA\Circles\Service\FederatedUserService;
use OCA\Circles\Service\MemberService;
use OCA\Circles\Service\MembershipService;
use OCA\Circles\Service\SearchService;
use OCA\Circles\Tools\Traits\TDeserialize;
use OCA\Circles\Tools\Traits\TNCLogger;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCS\OCSException;
use OCP\AppFramework\OCSController;
Expand Down Expand Up @@ -150,11 +151,11 @@ public function create(
} catch (Exception $e) {
$this->e(
$e, [
'emulated' => $emulated,
'name' => $name,
'members' => $personal,
'local' => $local
]
'emulated' => $emulated,
'name' => $name,
'members' => $personal,
'local' => $local
]
);
throw new OcsException($e->getMessage(), $e->getCode());
}
Expand Down Expand Up @@ -211,11 +212,11 @@ public function memberAdd(string $emulated, string $circleId, string $userId, in
} catch (Exception $e) {
$this->e(
$e, [
'emulated' => $emulated,
'circleId' => $circleId,
'userId' => $userId,
'type' => $type
]
'emulated' => $emulated,
'circleId' => $circleId,
'userId' => $userId,
'type' => $type
]
);
throw new OCSException($e->getMessage(), $e->getCode());
}
Expand Down Expand Up @@ -263,6 +264,7 @@ public function memberLevel(string $emulated, string $circleId, string $memberId
* @param string $emulated
* @param int $limit
* @param int $offset
*
* @return DataResponse
* @throws OCSException
*/
Expand Down Expand Up @@ -468,7 +470,12 @@ public function editDescription(string $emulated, string $circleId, string $valu
* @return DataResponse
* @throws OCSException
*/
public function editSetting(string $emulated, string $circleId, string $setting, ?string $value = null): DataResponse {
public function editSetting(
string $emulated,
string $circleId,
string $setting,
?string $value = null
): DataResponse {
try {
$this->setLocalFederatedUser($emulated);

Expand All @@ -482,9 +489,6 @@ public function editSetting(string $emulated, string $circleId, string $setting,
}





/**
* @param string $emulated
* @param string $circleId
Expand Down Expand Up @@ -528,6 +532,39 @@ public function link(string $emulated, string $circleId, string $singleId): Data
}


/**
* @param string $emulated
* @param string $type
* @param int $level
* @param string $details
*
* @return DataResponse
* @throws OCSException
*/
public function memberships(
string $emulated,
string $type = 'inherited',
int $level = Member::LEVEL_MEMBER,
string $details = 'false'
): DataResponse {
try {
$this->setLocalFederatedUser($emulated);

$probe = new MemberProbe();
$probe->setMinimumLevel($level);
$probe->initiatorAsDirectMember((strtolower($type) === 'direct'));
$probe->detailedMembership(strtolower($details) === 'true');

$result = $this->memberService->getMemberships($probe);

return new DataResponse($this->serializeArray($result));
} catch (Exception $e) {
$this->e($e, ['type' => $type, 'level' => $level]);
throw new OCSException($e->getMessage(), $e->getCode());
}
}


/**
* @param string $emulated
*
Expand Down
44 changes: 41 additions & 3 deletions lib/Controller/LocalController.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@

namespace OCA\Circles\Controller;

use OCA\Circles\Tools\Traits\TDeserialize;
use OCA\Circles\Tools\Traits\TNCLogger;
use Exception;
use OCA\Circles\Exceptions\FederatedUserException;
use OCA\Circles\Exceptions\FederatedUserNotFoundException;
Expand All @@ -44,12 +42,15 @@
use OCA\Circles\Model\Member;
use OCA\Circles\Model\Probes\BasicProbe;
use OCA\Circles\Model\Probes\CircleProbe;
use OCA\Circles\Model\Probes\MemberProbe;
use OCA\Circles\Service\CircleService;
use OCA\Circles\Service\ConfigService;
use OCA\Circles\Service\FederatedUserService;
use OCA\Circles\Service\MemberService;
use OCA\Circles\Service\MembershipService;
use OCA\Circles\Service\SearchService;
use OCA\Circles\Tools\Traits\TDeserialize;
use OCA\Circles\Tools\Traits\TNCLogger;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCS\OCSException;
use OCP\AppFramework\OCSController;
Expand Down Expand Up @@ -326,6 +327,39 @@ public function circleLeave(string $circleId): DataResponse {
}


/**
* @NoAdminRequired
*
* @param string $type
* @param int $level
* @param bool $details
*
* @return DataResponse
* @throws OCSException
*/
public function memberships(
string $type = 'inherited',
int $level = Member::LEVEL_MEMBER,
string $details = 'false'
): DataResponse {
try {
$this->setCurrentFederatedUser();

$probe = new MemberProbe();
$probe->setMinimumLevel($level)
->initiatorAsDirectMember((strtolower($type) === 'direct'))
->detailedMembership(strtolower($details) === 'true');

$result = $this->memberService->getMemberships($probe);

return new DataResponse($this->serializeArray($result));
} catch (Exception $e) {
$this->e($e, ['type' => $type, 'level' => $level]);
throw new OCSException($e->getMessage(), $e->getCode());
}
}


/**
* @NoAdminRequired
*
Expand Down Expand Up @@ -512,7 +546,11 @@ public function editDescription(string $circleId, string $value): DataResponse {
* @return DataResponse
* @throws OCSException
*/
public function editSetting(string $circleId, string $setting, ?string $value = null): DataResponse {
public function editSetting(
string $circleId,
string $setting,
?string $value = null
): DataResponse {
try {
$this->setCurrentFederatedUser();

Expand Down
16 changes: 15 additions & 1 deletion lib/Db/CoreQueryBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,13 @@ class CoreQueryBuilder extends ExtendedQueryBuilder {
]
],
self::MEMBERSHIPS => [
self::CIRCLE => [
self::MEMBERSHIPS => [ // needed ?
self::CONFIG,
self::INITIATOR
],
self::INITIATOR => [self::INHERITED_BY => [self::MEMBERSHIPS]]
],
self::CONFIG
],
self::SHARE => [
Expand Down Expand Up @@ -385,6 +392,14 @@ public function limitToShareParent(int $shareId): void {
}


/**
* @param int $level
*/
public function minLevel(int $level): void {
$this->gt('level', $level, true);
}


/**
* @param Circle $circle
*/
Expand Down Expand Up @@ -1131,7 +1146,6 @@ public function leftJoinInitiator(
)
);


$listMembershipCircleAlias = [$aliasMembership];
if ($this->getBool('initiatorDirectMember', $options, false)) {
try {
Expand Down
30 changes: 29 additions & 1 deletion lib/Db/MembershipRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,10 @@
namespace OCA\Circles\Db;

use OCA\Circles\Exceptions\MembershipNotFoundException;
use OCA\Circles\Exceptions\RequestBuilderException;
use OCA\Circles\Model\FederatedUser;
use OCA\Circles\Model\Membership;
use OCA\Circles\Model\Probes\MemberProbe;
use OCP\DB\QueryBuilder\IQueryBuilder;

/**
Expand Down Expand Up @@ -102,12 +104,38 @@ public function getMembership(string $circleId, string $singleId): Membership {
}


/**
* @param MemberProbe|null $probe
* @param FederatedUser|null $initiator
*
* @return Membership[]
* @throws RequestBuilderException
*/
public function getMemberships(FederatedUser $initiator, MemberProbe $probe): array {
$qb = $this->getMembershipSelectSql();
$qb->limitToSingleId($initiator->getSingleId());
$qb->leftJoinCircleConfig(CoreQueryBuilder::MEMBERSHIPS);

$qb->minLevel($probe->getMinimumLevel());
if ($probe->directMemberInitiator()) {
$qb->limitInt('inheritance_depth', 1);
}

if ($probe->isDetailedMembership()) {
$qb->setOptions([CoreQueryBuilder::MEMBERSHIPS, CoreQueryBuilder::CIRCLE], ['getData' => true]);
$qb->leftJoinCircle(CoreQueryBuilder::MEMBERSHIPS, $initiator);
}

return $this->getItemsFromRequest($qb);
}


/**
* @param string $singleId
*
* @return Membership[]
*/
public function getMemberships(string $singleId): array {
public function getMembershipsBySingleId(string $singleId): array {
$qb = $this->getMembershipSelectSql();
$qb->limitToSingleId($singleId);
$qb->leftJoinCircleConfig(CoreQueryBuilder::MEMBERSHIPS);
Expand Down
25 changes: 25 additions & 0 deletions lib/Model/Membership.php
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ class Membership extends ManagedModel implements IDeserializable, IQueryRow, Jso
/** @var array */
private $inheritanceDetails = [];

/** @var Circle */
private $circle;


/**
* Membership constructor.
Expand Down Expand Up @@ -271,6 +274,21 @@ public function getInheritanceDetails(): array {
}


public function hasCircle(): bool {
return (!is_null($this->circle));
}

public function setCircle(Circle $circle): self {
$this->circle = $circle;

return $this;
}

public function getCircle(): Circle {
return $this->circle;
}


/**
* @param array $data
*
Expand Down Expand Up @@ -315,6 +333,8 @@ public function importFromDatabase(array $data, string $prefix = ''): IQueryRow
$this->setInheritancePath($this->getArray($prefix . 'inheritance_path', $data));
$this->setInheritanceDepth($this->getInt($prefix . 'inheritance_depth', $data));

$this->getManager()->manageImportFromDatabase($this, $data, $prefix);

return $this;
}

Expand All @@ -338,6 +358,11 @@ public function jsonSerialize(): array {
$result['inheritanceDetails'] = $this->getInheritanceDetails();
}

if ($this->hasCircle()) {
$result['circle'] = $this->getCircle();
}

return $result;
}

}
Loading