mirror of
https://github.com/netzbegruenung/circles.git
synced 2024-05-14 09:06:06 +02:00
292 lines
6.6 KiB
PHP
292 lines
6.6 KiB
PHP
<?php
|
|
/**
|
|
* 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@pontapreta.net>
|
|
* @copyright 2017
|
|
* @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\Model;
|
|
|
|
use OCA\Circles\Exceptions\CircleTypeNotValidException;
|
|
use OCA\Circles\Exceptions\MemberAlreadyExistsException;
|
|
use OCA\Circles\Exceptions\MemberCantJoinCircleException;
|
|
use OCA\Circles\Exceptions\MemberDoesNotExistException;
|
|
use OCA\Circles\Exceptions\MemberIsBlockedException;
|
|
use OCA\Circles\Exceptions\MemberIsNotAdminException;
|
|
use OCA\Circles\Exceptions\MemberIsNotModeratorException;
|
|
use OCA\Circles\Exceptions\MemberIsNotOwnerException;
|
|
use OCA\Circles\Exceptions\MemberIsOwnerException;
|
|
use OCA\Circles\Exceptions\MemberTypeCantEditLevelException;
|
|
use OCA\Circles\Exceptions\ModeratorIsNotHighEnoughException;
|
|
|
|
class Member extends BaseMember {
|
|
|
|
|
|
public function inviteToCircle($circleType) {
|
|
|
|
if ($circleType === 0) {
|
|
throw new CircleTypeNotValidException('Invalid circle type');
|
|
}
|
|
|
|
if ($circleType === Circle::CIRCLES_CLOSED) {
|
|
return $this->inviteIntoClosedCircle();
|
|
}
|
|
|
|
return $this->addMemberToCircle();
|
|
}
|
|
|
|
|
|
/**
|
|
* @param int $circleType
|
|
*
|
|
* @throws MemberCantJoinCircleException
|
|
*/
|
|
public function joinCircle($circleType) {
|
|
|
|
switch ($circleType) {
|
|
case Circle::CIRCLES_SECRET:
|
|
case Circle::CIRCLES_PUBLIC:
|
|
return $this->addMemberToCircle();
|
|
|
|
case Circle::CIRCLES_CLOSED:
|
|
return $this->joinClosedCircle();
|
|
}
|
|
|
|
throw new MemberCantJoinCircleException($this->l10n->t('You cannot join this circle'));
|
|
}
|
|
|
|
|
|
/**
|
|
* Update status of member like he joined a public circle.
|
|
*/
|
|
public function addMemberToCircle() {
|
|
|
|
if ($this->getStatus() === Member::STATUS_NONMEMBER
|
|
|| $this->getStatus() === Member::STATUS_KICKED
|
|
) {
|
|
$this->setAsAMember(Member::LEVEL_MEMBER);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Update status of member like he joined a closed circle
|
|
* (invite/request)
|
|
*/
|
|
private function joinClosedCircle() {
|
|
|
|
switch ($this->getStatus()) {
|
|
case Member::STATUS_NONMEMBER:
|
|
case Member::STATUS_KICKED:
|
|
$this->setStatus(Member::STATUS_REQUEST);
|
|
break;
|
|
|
|
case Member::STATUS_INVITED:
|
|
$this->setAsAMember(Member::LEVEL_MEMBER);
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
private function inviteIntoClosedCircle() {
|
|
switch ($this->getStatus()) {
|
|
case Member::STATUS_NONMEMBER:
|
|
case Member::STATUS_KICKED:
|
|
$this->setStatus(Member::STATUS_INVITED);
|
|
break;
|
|
|
|
case Member::STATUS_REQUEST:
|
|
$this->setAsAMember(Member::LEVEL_MEMBER);
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws MemberIsNotModeratorException
|
|
*/
|
|
public function hasToBeModerator() {
|
|
if ($this->getLevel() < self::LEVEL_MODERATOR) {
|
|
throw new MemberIsNotModeratorException(
|
|
$this->l10n->t('This member is not a moderator')
|
|
);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @param $level
|
|
*
|
|
* @throws ModeratorIsNotHighEnoughException
|
|
*/
|
|
public function hasToBeHigherLevel($level) {
|
|
|
|
if ($this->getLevel() <= $level) {
|
|
throw new ModeratorIsNotHighEnoughException(
|
|
$this->l10n->t('Insufficient privileges')
|
|
);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws MemberIsNotModeratorException
|
|
*/
|
|
public function hasToBeOwner() {
|
|
if ($this->getLevel() < self::LEVEL_OWNER) {
|
|
throw new MemberIsNotOwnerException(
|
|
$this->l10n->t('This member is not the owner of the circle')
|
|
);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws MemberIsNotModeratorException
|
|
*/
|
|
public function hasToBeAdmin() {
|
|
if ($this->getLevel() < self::LEVEL_ADMIN) {
|
|
throw new MemberIsNotAdminException(
|
|
$this->l10n->t('This member is not an admin of the circle')
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @throws MemberDoesNotExistException
|
|
*/
|
|
public function hasToBeMember() {
|
|
if ($this->getLevel() < self::LEVEL_MEMBER) {
|
|
throw new MemberDoesNotExistException($this->l10n->t('This member does not exist'));
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws MemberDoesNotExistException
|
|
*/
|
|
public function hasToBeMemberOrAlmost() {
|
|
if ($this->isAlmostMember() || $this->hasToBeMember()) {
|
|
return true;
|
|
}
|
|
|
|
throw new MemberDoesNotExistException($this->l10n->t('This member does not exist'));
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws MemberIsOwnerException
|
|
*/
|
|
public function cantBeOwner() {
|
|
if ($this->getLevel() === self::LEVEL_OWNER) {
|
|
throw new MemberIsOwnerException(
|
|
$this->l10n->t('This member is the owner of the circle')
|
|
);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* return if member already exists
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function alreadyExistOrJoining() {
|
|
return ($this->getLevel() > Member::LEVEL_NONE
|
|
|| ($this->getStatus() !== Member::STATUS_NONMEMBER
|
|
&& $this->getStatus() !== Member::STATUS_REQUEST)
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
* @param bool $able
|
|
*/
|
|
public function broadcasting($able) {
|
|
$this->broadcasting = $able;
|
|
}
|
|
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isBroadcasting() {
|
|
return $this->broadcasting;
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws MemberTypeCantEditLevelException
|
|
*/
|
|
public function levelHasToBeEditable() {
|
|
if ($this->getType() !== self::TYPE_USER) {
|
|
throw new MemberTypeCantEditLevelException(
|
|
$this->l10n->t('Level cannot be changed for this type of member')
|
|
);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws MemberAlreadyExistsException
|
|
* @throws MemberIsBlockedException
|
|
*/
|
|
public function hasToBeAbleToJoinTheCircle() {
|
|
|
|
if ($this->getLevel() > 0) {
|
|
throw new MemberAlreadyExistsException(
|
|
$this->l10n->t("You are already a member of this circle")
|
|
);
|
|
}
|
|
|
|
if ($this->getStatus() === Member::STATUS_BLOCKED) {
|
|
throw new MemberIsBlockedException(
|
|
$this->l10n->t("You have been blocked from this circle")
|
|
);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @throws MemberAlreadyExistsException
|
|
*/
|
|
public function hasToBeInviteAble() {
|
|
|
|
if ($this->getLevel() > 0) {
|
|
throw new MemberAlreadyExistsException(
|
|
$this->l10n->t("The user is already a member of this circle")
|
|
);
|
|
}
|
|
|
|
if ($this->getStatus() === Member::STATUS_INVITED) {
|
|
throw new MemberAlreadyExistsException(
|
|
$this->l10n->t("The user has already been invited into this circle")
|
|
);
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
|