mirror of
https://github.com/netzbegruenung/circles.git
synced 2024-05-04 21:03:40 +02:00
406 lines
11 KiB
PHP
406 lines
11 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
|
|
/**
|
|
* Circles - Bring cloud-users closer together.
|
|
*
|
|
* This file is licensed under the Affero General Public License version 3 or
|
|
* later. See the COPYING file.
|
|
*
|
|
* @author Maxence Lange <maxence@artificial-owl.com>
|
|
* @copyright 2021
|
|
* @license GNU AGPL version 3 or any later version
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
|
|
namespace OCA\Circles\Db;
|
|
|
|
use ArtificialOwl\MySmallPhpTools\Model\SimpleDataStore;
|
|
use OCA\Circles\Exceptions\CircleNotFoundException;
|
|
use OCA\Circles\Exceptions\FederatedUserNotFoundException;
|
|
use OCA\Circles\Exceptions\InvalidIdException;
|
|
use OCA\Circles\Exceptions\OwnerNotFoundException;
|
|
use OCA\Circles\Exceptions\RequestBuilderException;
|
|
use OCA\Circles\Exceptions\SingleCircleNotFoundException;
|
|
use OCA\Circles\IFederatedUser;
|
|
use OCA\Circles\Model\Circle;
|
|
use OCA\Circles\Model\Federated\RemoteInstance;
|
|
use OCA\Circles\Model\FederatedUser;
|
|
use OCA\Circles\Model\Member;
|
|
|
|
/**
|
|
* Class CircleRequest
|
|
*
|
|
* @package OCA\Circles\Db
|
|
*/
|
|
class CircleRequest extends CircleRequestBuilder {
|
|
|
|
|
|
/**
|
|
* @param Circle $circle
|
|
*
|
|
* @throws InvalidIdException
|
|
*/
|
|
public function save(Circle $circle): void {
|
|
$this->confirmValidId($circle->getSingleId());
|
|
|
|
$qb = $this->getCircleInsertSql();
|
|
$qb->setValue('unique_id', $qb->createNamedParameter($circle->getSingleId()))
|
|
->setValue('name', $qb->createNamedParameter($circle->getName()))
|
|
->setValue('source', $qb->createNamedParameter($circle->getSource()))
|
|
->setValue('display_name', $qb->createNamedParameter($circle->getDisplayName()))
|
|
->setValue('sanitized_name', $qb->createNamedParameter($circle->getSanitizedName()))
|
|
->setValue('description', $qb->createNamedParameter($circle->getDescription()))
|
|
->setValue('contact_addressbook', $qb->createNamedParameter($circle->getContactAddressBook()))
|
|
->setValue('contact_groupname', $qb->createNamedParameter($circle->getContactGroupName()))
|
|
->setValue('settings', $qb->createNamedParameter(json_encode($circle->getSettings())))
|
|
->setValue('config', $qb->createNamedParameter($circle->getConfig()));
|
|
|
|
$qb->execute();
|
|
}
|
|
|
|
|
|
/**
|
|
* @param Circle $circle
|
|
*/
|
|
public function edit(Circle $circle): void {
|
|
$qb = $this->getCircleUpdateSql();
|
|
$qb->set('name', $qb->createNamedParameter($circle->getName()))
|
|
->set('display_name', $qb->createNamedParameter($circle->getDisplayName()))
|
|
->set('sanitized_name', $qb->createNamedParameter($circle->getSanitizedName()))
|
|
->set('description', $qb->createNamedParameter($circle->getDescription()));
|
|
|
|
$qb->limitToUniqueId($circle->getSingleId());
|
|
|
|
$qb->execute();
|
|
}
|
|
|
|
/**
|
|
* @param Circle $circle
|
|
*/
|
|
public function update(Circle $circle) {
|
|
$qb = $this->getCircleUpdateSql();
|
|
$qb->set('name', $qb->createNamedParameter($circle->getName()))
|
|
->set('display_name', $qb->createNamedParameter($circle->getDisplayName()))
|
|
->set('description', $qb->createNamedParameter($circle->getDescription()))
|
|
->set('settings', $qb->createNamedParameter(json_encode($circle->getSettings())))
|
|
->set('config', $qb->createNamedParameter($circle->getConfig()));
|
|
|
|
$qb->limitToUniqueId($circle->getSingleId());
|
|
|
|
$qb->execute();
|
|
}
|
|
|
|
|
|
/**
|
|
* @param Circle $circle
|
|
*
|
|
* @throws InvalidIdException
|
|
*/
|
|
public function insertOrUpdate(Circle $circle): void {
|
|
try {
|
|
$this->getCircle($circle->getSingleId());
|
|
$this->update($circle);
|
|
} catch (CircleNotFoundException $e) {
|
|
$this->save($circle);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @param string $singleId
|
|
* @param string $displayName
|
|
*/
|
|
public function updateDisplayName(string $singleId, string $displayName): void {
|
|
$qb = $this->getCircleUpdateSql();
|
|
$qb->set('display_name', $qb->createNamedParameter($displayName));
|
|
|
|
$qb->limitToUniqueId($singleId);
|
|
|
|
$qb->execute();
|
|
}
|
|
|
|
|
|
/**
|
|
* @param Circle $circle
|
|
*/
|
|
public function updateConfig(Circle $circle) {
|
|
$qb = $this->getCircleUpdateSql();
|
|
$qb->set('config', $qb->createNamedParameter($circle->getConfig()));
|
|
|
|
$qb->limitToUniqueId($circle->getSingleId());
|
|
|
|
$qb->execute();
|
|
}
|
|
|
|
|
|
/**
|
|
* @param Circle|null $circleFilter
|
|
* @param Member|null $memberFilter
|
|
* @param IFederatedUser|null $initiator
|
|
* @param RemoteInstance|null $remoteInstance
|
|
* @param SimpleDataStore $params
|
|
*
|
|
* @return Circle[]
|
|
* @throws RequestBuilderException
|
|
*/
|
|
public function getCircles(
|
|
?Circle $circleFilter,
|
|
?Member $memberFilter,
|
|
?IFederatedUser $initiator,
|
|
?RemoteInstance $remoteInstance,
|
|
SimpleDataStore $params
|
|
): array {
|
|
$qb = $this->getCircleSelectSql();
|
|
$qb->leftJoinOwner(CoreQueryBuilder::CIRCLE);
|
|
$qb->setOptions(
|
|
[CoreQueryBuilder::CIRCLE],
|
|
[
|
|
'getData' => true,
|
|
'mustBeMember' => $params->gBool('mustBeMember'),
|
|
'initiatorDirectMember' => true
|
|
]
|
|
);
|
|
|
|
if (!$params->gBool('includeSystemCircles')) {
|
|
$qb->filterCircles(
|
|
CoreQueryBuilder::CIRCLE,
|
|
Circle::CFG_SINGLE | Circle::CFG_HIDDEN | Circle::CFG_BACKEND
|
|
);
|
|
}
|
|
if (!is_null($initiator)) {
|
|
$qb->limitToInitiator(CoreQueryBuilder::CIRCLE, $initiator);
|
|
}
|
|
if (!is_null($memberFilter)) {
|
|
$qb->limitToDirectMembership(CoreQueryBuilder::CIRCLE, $memberFilter);
|
|
}
|
|
if (!is_null($circleFilter)) {
|
|
$qb->filterCircle($circleFilter);
|
|
}
|
|
if (!is_null($remoteInstance)) {
|
|
$qb->limitToRemoteInstance(CoreQueryBuilder::CIRCLE, $remoteInstance, false);
|
|
}
|
|
|
|
$qb->countMembers(CoreQueryBuilder::CIRCLE);
|
|
$qb->chunk($params->gInt('offset'), $params->gInt('limit'));
|
|
|
|
return $this->getItemsFromRequest($qb);
|
|
}
|
|
|
|
|
|
/**
|
|
* @param array $circleIds
|
|
*
|
|
* @return array
|
|
* @throws RequestBuilderException
|
|
*/
|
|
public function getCirclesByIds(array $circleIds): array {
|
|
$qb = $this->getCircleSelectSql();
|
|
$qb->setOptions([CoreQueryBuilder::CIRCLE], ['getData' => true, 'canBeVisitor' => true]);
|
|
|
|
$qb->limitInArray('unique_id', $circleIds);
|
|
// $qb->filterCircles(CoreQueryBuilder::CIRCLE, $filter);
|
|
$qb->leftJoinOwner(CoreQueryBuilder::CIRCLE);
|
|
|
|
return $this->getItemsFromRequest($qb);
|
|
}
|
|
|
|
/**
|
|
* @param string $id
|
|
* @param IFederatedUser|null $initiator
|
|
* @param RemoteInstance|null $remoteInstance
|
|
* @param int $filter
|
|
*
|
|
* @return Circle
|
|
* @throws CircleNotFoundException
|
|
* @throws RequestBuilderException
|
|
*/
|
|
public function getCircle(
|
|
string $id,
|
|
?IFederatedUser $initiator = null,
|
|
?RemoteInstance $remoteInstance = null,
|
|
int $filter = Circle::CFG_BACKEND | Circle::CFG_SINGLE | Circle::CFG_HIDDEN
|
|
): Circle {
|
|
$qb = $this->getCircleSelectSql();
|
|
$qb->setOptions(
|
|
[CoreQueryBuilder::CIRCLE],
|
|
[
|
|
'getData' => true,
|
|
'canBeVisitor' => true,
|
|
'initiatorDirectMember' => true
|
|
]
|
|
);
|
|
|
|
$qb->limitToUniqueId($id);
|
|
$qb->filterCircles(CoreQueryBuilder::CIRCLE, $filter);
|
|
$qb->leftJoinOwner(CoreQueryBuilder::CIRCLE);
|
|
// $qb->setOptions(
|
|
// [CoreRequestBuilder::CIRCLE, CoreRequestBuilder::INITIATOR], [
|
|
// 'mustBeMember' => false,
|
|
// 'canBeVisitor' => true
|
|
// ]
|
|
// );
|
|
|
|
if (!is_null($initiator)) {
|
|
$qb->limitToInitiator(CoreQueryBuilder::CIRCLE, $initiator);
|
|
}
|
|
if (!is_null($remoteInstance)) {
|
|
$qb->limitToRemoteInstance(CoreQueryBuilder::CIRCLE, $remoteInstance, false);
|
|
}
|
|
$qb->countMembers(CoreQueryBuilder::CIRCLE);
|
|
|
|
return $this->getItemFromRequest($qb);
|
|
}
|
|
|
|
|
|
/**
|
|
* @param string $singleId
|
|
*
|
|
* @return FederatedUser
|
|
* @throws OwnerNotFoundException
|
|
* @throws RequestBuilderException
|
|
* @throws FederatedUserNotFoundException
|
|
*/
|
|
public function getFederatedUserBySingleId(string $singleId): FederatedUser {
|
|
$qb = $this->getCircleSelectSql();
|
|
$qb->limitToUniqueId($singleId);
|
|
$qb->leftJoinOwner(CoreQueryBuilder::CIRCLE);
|
|
|
|
try {
|
|
$circle = $this->getItemFromRequest($qb);
|
|
} catch (CircleNotFoundException $e) {
|
|
throw new FederatedUserNotFoundException('singleId not found');
|
|
}
|
|
|
|
$federatedUser = new FederatedUser();
|
|
$federatedUser->importFromCircle($circle);
|
|
|
|
return $federatedUser;
|
|
}
|
|
|
|
|
|
/**
|
|
* method that return the single-user Circle based on a FederatedUser.
|
|
*
|
|
* @param IFederatedUser $initiator
|
|
*
|
|
* @return Circle
|
|
* @throws SingleCircleNotFoundException
|
|
* @throws RequestBuilderException
|
|
*/
|
|
public function getSingleCircle(IFederatedUser $initiator): Circle {
|
|
$qb = $this->getCircleSelectSql(CoreQueryBuilder::SINGLE);
|
|
|
|
if ($initiator instanceof FederatedUser) {
|
|
$member = new Member();
|
|
$member->importFromIFederatedUser($initiator);
|
|
$member->setLevel(Member::LEVEL_OWNER);
|
|
} else {
|
|
$member = clone $initiator;
|
|
}
|
|
|
|
$qb->limitToDirectMembership(CoreQueryBuilder::SINGLE, $member);
|
|
$qb->limitToConfigFlag(Circle::CFG_SINGLE);
|
|
|
|
try {
|
|
return $this->getItemFromRequest($qb);
|
|
} catch (CircleNotFoundException $e) {
|
|
throw new SingleCircleNotFoundException();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @param Circle $circle
|
|
* @param IFederatedUser|null $initiator
|
|
*
|
|
* @return Circle
|
|
* @throws CircleNotFoundException
|
|
* @throws RequestBuilderException
|
|
*/
|
|
public function searchCircle(Circle $circle, ?IFederatedUser $initiator = null): Circle {
|
|
$qb = $this->getCircleSelectSql();
|
|
$qb->leftJoinOwner(CoreQueryBuilder::CIRCLE);
|
|
|
|
if ($circle->getName() !== '') {
|
|
$qb->limitToName($circle->getName());
|
|
}
|
|
if ($circle->getDisplayName() !== '') {
|
|
$qb->limitToDisplayName($circle->getDisplayName());
|
|
}
|
|
if ($circle->getSanitizedName() !== '') {
|
|
$qb->limitToSanitizedName($circle->getSanitizedName());
|
|
}
|
|
if ($circle->getConfig() > 0) {
|
|
$qb->limitToConfig($circle->getConfig());
|
|
}
|
|
if ($circle->getSource() > 0) {
|
|
$qb->limitToSource($circle->getSource());
|
|
}
|
|
|
|
if ($circle->hasOwner()) {
|
|
$aliasOwner = $qb->generateAlias(CoreQueryBuilder::CIRCLE, CoreQueryBuilder::OWNER);
|
|
$qb->filterDirectMembership($aliasOwner, $circle->getOwner());
|
|
}
|
|
|
|
if (!is_null($initiator)) {
|
|
$qb->setOptions([CoreQueryBuilder::CIRCLE], ['getData' => true]);
|
|
$qb->limitToInitiator(CoreQueryBuilder::CIRCLE, $initiator);
|
|
}
|
|
|
|
return $this->getItemFromRequest($qb);
|
|
}
|
|
|
|
|
|
/**
|
|
* @return Circle[]
|
|
* @throws RequestBuilderException
|
|
*/
|
|
public function getFederated(): array {
|
|
$qb = $this->getCircleSelectSql();
|
|
$qb->limitToConfigFlag(Circle::CFG_FEDERATED, CoreQueryBuilder::CIRCLE);
|
|
|
|
$qb->leftJoinOwner(CoreQueryBuilder::CIRCLE);
|
|
|
|
return $this->getItemsFromRequest($qb);
|
|
}
|
|
|
|
|
|
/**
|
|
* @param Circle $circle
|
|
*/
|
|
public function delete(Circle $circle): void {
|
|
$qb = $this->getCircleDeleteSql();
|
|
$qb->limitToUniqueId($circle->getSingleId());
|
|
|
|
$qb->execute();
|
|
}
|
|
|
|
|
|
/**
|
|
* @param IFederatedUser $federatedUser
|
|
*/
|
|
public function deleteFederatedUser(IFederatedUser $federatedUser): void {
|
|
$qb = $this->getCircleDeleteSql();
|
|
$qb->limitToUniqueId($federatedUser->getSingleId());
|
|
|
|
$qb->execute();
|
|
}
|
|
}
|