Skip to content

Commit

Permalink
Moved RoleDomainMapper from Helper to Mapper namespace.
Browse files Browse the repository at this point in the history 
Moved \eZ\Publish\Core\Repository\Helper\RoleDomainMapper to \eZ\Publish\Core\Repository\Mapper\RoleDomainMapper.

Kept Helper\RoleDomainMapper for temporary BC with 1st party packages.
  • Loading branch information
@alongosz
alongosz committed Apr 8, 2020
1 parent f344942 commit 2701726
Show file tree
Hide file tree
Showing 11 changed files with 272 additions and 252 deletions.
2 changes: 1 addition & 1 deletion eZ/Publish/Core/Helper/Tests/ContentInfoLocationLoader/SudoMainLocationLoaderTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
use eZ\Publish\API\Repository\LocationService;
use eZ\Publish\Core\Repository\Repository;
use eZ\Publish\Core\Repository\Permission\PermissionResolver;
use eZ\Publish\Core\Repository\Helper\RoleDomainMapper;
use eZ\Publish\Core\Repository\Mapper\RoleDomainMapper;
use eZ\Publish\Core\Repository\Permission\LimitationService;
use eZ\Publish\SPI\Persistence\User\Handler as SPIUserHandler;
use eZ\Publish\API\Repository\Values\User\UserReference;
Expand Down
2 changes: 1 addition & 1 deletion eZ/Publish/Core/MVC/Symfony/Matcher/Tests/ContentBased/BaseTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
use eZ\Publish\API\Repository\Values\Content\ContentInfo;
use eZ\Publish\API\Repository\Values\Content\Location;
use eZ\Publish\Core\Repository\Permission\PermissionResolver;
use eZ\Publish\Core\Repository\Helper\RoleDomainMapper;
use eZ\Publish\Core\Repository\Mapper\RoleDomainMapper;
use eZ\Publish\API\Repository\Values\User\UserReference;
use eZ\Publish\SPI\Persistence\User\Handler as SPIUserHandler;
use eZ\Publish\Core\Repository\Permission\LimitationService;
Expand Down
2 changes: 1 addition & 1 deletion eZ/Publish/Core/MVC/Symfony/Routing/Tests/UrlAliasGeneratorTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
use eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessRouterInterface;
use eZ\Publish\Core\MVC\ConfigResolverInterface;
use eZ\Publish\Core\Repository\Permission\LimitationService;
use eZ\Publish\Core\Repository\Helper\RoleDomainMapper;
use eZ\Publish\Core\Repository\Mapper\RoleDomainMapper;
use eZ\Publish\Core\Repository\Repository;
use eZ\Publish\Core\Repository\Values\Content\Location;
use eZ\Publish\SPI\Persistence\User\Handler as SPIUserHandler;
Expand Down
2 changes: 1 addition & 1 deletion .../Symfony/Security/Tests/Authentication/RememberMeRepositoryAuthenticationProviderTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
use eZ\Publish\Core\MVC\Symfony\Security\Authentication\RememberMeRepositoryAuthenticationProvider;
use eZ\Publish\Core\MVC\Symfony\Security\User;
use eZ\Publish\Core\Repository\Permission\LimitationService;
use eZ\Publish\Core\Repository\Helper\RoleDomainMapper;
use eZ\Publish\Core\Repository\Mapper\RoleDomainMapper;
use eZ\Publish\SPI\Persistence\User\Handler as UserHandler;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Security\Core\Authentication\Token\AnonymousToken;
Expand Down
239 changes: 4 additions & 235 deletions eZ/Publish/Core/Repository/Helper/RoleDomainMapper.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,246 +6,15 @@
*/
namespace eZ\Publish\Core\Repository\Helper;

use eZ\Publish\Core\Repository\Permission\LimitationService;
use eZ\Publish\Core\Repository\Values\User\Policy;
use eZ\Publish\Core\Repository\Values\User\PolicyDraft;
use eZ\Publish\Core\Repository\Values\User\Role;
use eZ\Publish\API\Repository\Values\User\Role as APIRole;
use eZ\Publish\Core\Repository\Values\User\RoleDraft;
use eZ\Publish\API\Repository\Values\User\RoleCopyStruct as APIRoleCopyStruct;
use eZ\Publish\API\Repository\Values\User\RoleCreateStruct as APIRoleCreateStruct;
use eZ\Publish\Core\Repository\Values\User\UserRoleAssignment;
use eZ\Publish\Core\Repository\Values\User\UserGroupRoleAssignment;
use eZ\Publish\API\Repository\Values\User\User;
use eZ\Publish\API\Repository\Values\User\UserGroup;
use eZ\Publish\SPI\Persistence\User\Policy as SPIPolicy;
use eZ\Publish\SPI\Persistence\User\RoleAssignment as SPIRoleAssignment;
use eZ\Publish\SPI\Persistence\User\Role as SPIRole;
use eZ\Publish\SPI\Persistence\User\RoleCopyStruct as SPIRoleCopyStruct;
use eZ\Publish\SPI\Persistence\User\RoleCreateStruct as SPIRoleCreateStruct;
use eZ\Publish\Core\Repository\Mapper\RoleDomainMapper as MapperRoleDomainMapper;

/**
* Internal service to map Role objects between API and SPI values.
*
* @internal Meant for internal use by Repository.
*
* @deprecated since eZ Platform 3.0.1, to be removed in eZ Platform 3.0.x (it's internal - no BC promise)
*/
class RoleDomainMapper
class RoleDomainMapper extends MapperRoleDomainMapper
{
/** @var \eZ\Publish\Core\Repository\Permission\LimitationService */
protected $limitationService;

/**
* @param \eZ\Publish\Core\Repository\Permission\LimitationService $limitationService
*/
public function __construct(LimitationService $limitationService)
{
$this->limitationService = $limitationService;
}

/**
* Maps provided SPI Role value object to API Role value object.
*
* @param \eZ\Publish\SPI\Persistence\User\Role $role
*
* @return \eZ\Publish\API\Repository\Values\User\Role
*/
public function buildDomainRoleObject(SPIRole $role)
{
$rolePolicies = [];
foreach ($role->policies as $spiPolicy) {
$rolePolicies[] = $this->buildDomainPolicyObject($spiPolicy);
}

return new Role(
[
'id' => $role->id,
'identifier' => $role->identifier,
'status' => $role->status,
'policies' => $rolePolicies,
]
);
}

/**
* Builds a RoleDraft domain object from value object returned by persistence
* Decorates Role.
*
* @param \eZ\Publish\SPI\Persistence\User\Role $spiRole
*
* @return \eZ\Publish\API\Repository\Values\User\RoleDraft
*/
public function buildDomainRoleDraftObject(SPIRole $spiRole)
{
return new RoleDraft(
[
'innerRole' => $this->buildDomainRoleObject($spiRole),
]
);
}

/**
* Maps provided SPI Policy value object to API Policy value object.
*
* @param \eZ\Publish\SPI\Persistence\User\Policy $spiPolicy
*
* @return \eZ\Publish\API\Repository\Values\User\Policy|\eZ\Publish\API\Repository\Values\User\PolicyDraft
*/
public function buildDomainPolicyObject(SPIPolicy $spiPolicy)
{
$policyLimitations = [];
if ($spiPolicy->module !== '*' && $spiPolicy->function !== '*' && $spiPolicy->limitations !== '*') {
foreach ($spiPolicy->limitations as $identifier => $values) {
$policyLimitations[] = $this->limitationService->getLimitationType($identifier)->buildValue($values);
}
}

$policy = new Policy(
[
'id' => $spiPolicy->id,
'roleId' => $spiPolicy->roleId,
'module' => $spiPolicy->module,
'function' => $spiPolicy->function,
'limitations' => $policyLimitations,
]
);

// Original ID is set on SPI policy, which means that it's a draft.
if ($spiPolicy->originalId) {
$policy = new PolicyDraft(['innerPolicy' => $policy, 'originalId' => $spiPolicy->originalId]);
}

return $policy;
}

/**
* Builds the API UserRoleAssignment object from provided SPI RoleAssignment object.
*
* @param \eZ\Publish\SPI\Persistence\User\RoleAssignment $spiRoleAssignment
* @param \eZ\Publish\API\Repository\Values\User\User $user
* @param \eZ\Publish\API\Repository\Values\User\Role $role
*
* @return \eZ\Publish\API\Repository\Values\User\UserRoleAssignment
*/
public function buildDomainUserRoleAssignmentObject(SPIRoleAssignment $spiRoleAssignment, User $user, APIRole $role)
{
$limitation = null;
if (!empty($spiRoleAssignment->limitationIdentifier)) {
$limitation = $this
->limitationService
->getLimitationType($spiRoleAssignment->limitationIdentifier)
->buildValue($spiRoleAssignment->values);
}

return new UserRoleAssignment(
[
'id' => $spiRoleAssignment->id,
'limitation' => $limitation,
'role' => $role,
'user' => $user,
]
);
}

/**
* Builds the API UserGroupRoleAssignment object from provided SPI RoleAssignment object.
*
* @param \eZ\Publish\SPI\Persistence\User\RoleAssignment $spiRoleAssignment
* @param \eZ\Publish\API\Repository\Values\User\UserGroup $userGroup
* @param \eZ\Publish\API\Repository\Values\User\Role $role
*
* @return \eZ\Publish\API\Repository\Values\User\UserGroupRoleAssignment
*/
public function buildDomainUserGroupRoleAssignmentObject(SPIRoleAssignment $spiRoleAssignment, UserGroup $userGroup, APIRole $role)
{
$limitation = null;
if (!empty($spiRoleAssignment->limitationIdentifier)) {
$limitation = $this
->limitationService
->getLimitationType($spiRoleAssignment->limitationIdentifier)
->buildValue($spiRoleAssignment->values);
}

return new UserGroupRoleAssignment(
[
'id' => $spiRoleAssignment->id,
'limitation' => $limitation,
'role' => $role,
'userGroup' => $userGroup,
]
);
}

/**
* Creates SPI Role create struct from provided API role create struct.
*/
public function buildPersistenceRoleCreateStruct(APIRoleCreateStruct $roleCreateStruct): SPIRoleCreateStruct
{
$policiesToCreate = $this->fillRoleStructWithPolicies($roleCreateStruct);

return new SPIRoleCreateStruct(
[
'identifier' => $roleCreateStruct->identifier,
'policies' => $policiesToCreate,
]
);
}

/**
* Creates SPI Role copy struct from provided API role copy struct.
*/
public function buildPersistenceRoleCopyStruct(APIRoleCopyStruct $roleCopyStruct, int $clonedId, int $status): SPIRoleCopyStruct
{
$policiesToCopy = $this->fillRoleStructWithPolicies($roleCopyStruct);

return new SPIRoleCopyStruct(
[
'clonedId' => $clonedId,
'newIdentifier' => $roleCopyStruct->newIdentifier,
'status' => $status,
'policies' => $policiesToCopy,
]
);
}

protected function fillRoleStructWithPolicies(APIRoleCreateStruct $struct): array
{
$policies = [];
foreach ($struct->getPolicies() as $policyStruct) {
$policies[] = $this->buildPersistencePolicyObject(
$policyStruct->module,
$policyStruct->function,
$policyStruct->getLimitations()
);
}

return $policies;
}

/**
* Creates SPI Policy value object from provided module, function and limitations.
*
* @param string $module
* @param string $function
* @param \eZ\Publish\API\Repository\Values\User\Limitation[] $limitations
*
* @return \eZ\Publish\SPI\Persistence\User\Policy
*/
public function buildPersistencePolicyObject($module, $function, array $limitations)
{
$limitationsToCreate = '*';
if ($module !== '*' && $function !== '*' && !empty($limitations)) {
$limitationsToCreate = [];
foreach ($limitations as $limitation) {
$limitationsToCreate[$limitation->getIdentifier()] = $limitation->limitationValues;
}
}

return new SPIPolicy(
[
'module' => $module,
'function' => $function,
'limitations' => $limitationsToCreate,
]
);
}
}

0 comments on commit 2701726

Please sign in to comment.