|
| 1 | +<?php |
| 2 | + |
| 3 | +/** |
| 4 | + * Copyright 2023 Google Inc. |
| 5 | + * |
| 6 | + * This program is free software; you can redistribute it and/or |
| 7 | + * modify it under the terms of the GNU General Public License |
| 8 | + * version 2 as published by the Free Software Foundation. |
| 9 | + * |
| 10 | + * This program is distributed in the hope that it will be useful, |
| 11 | + * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | + * GNU General Public License for more details. |
| 14 | + * |
| 15 | + * You should have received a copy of the GNU General Public License |
| 16 | + * along with this program; if not, write to the Free Software |
| 17 | + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, |
| 18 | + * MA 02110-1301, USA. |
| 19 | + */ |
| 20 | + |
| 21 | +namespace Drupal\apigee_edge_teams; |
| 22 | + |
| 23 | +use Apigee\Edge\Api\ApigeeX\Controller\AppGroupMembersController as ApigeeXAppGroupMembersController; |
| 24 | +use Apigee\Edge\Api\ApigeeX\Structure\AppGroupMembership; |
| 25 | +use Drupal\apigee_edge\Entity\Controller\OrganizationController; |
| 26 | +use Drupal\apigee_edge\SDKConnectorInterface; |
| 27 | +use Drupal\apigee_edge_teams\Entity\Form\TeamForm; |
| 28 | +use Drupal\apigee_edge_teams\Entity\TeamInvitationInterface; |
| 29 | +use Drupal\apigee_edge_teams\Entity\TeamMemberRoleInterface; |
| 30 | +use Drupal\Component\Serialization\Json; |
| 31 | + |
| 32 | +/** |
| 33 | + * Definition of the AppGroup members controller service. |
| 34 | + * |
| 35 | + * @internal You should use the team membership manager service instead of this. |
| 36 | + */ |
| 37 | +final class AppGroupMembersController implements AppGroupMembersControllerInterface { |
| 38 | + |
| 39 | + /** |
| 40 | + * Name of a appgroup. |
| 41 | + * |
| 42 | + * @var string |
| 43 | + */ |
| 44 | + private $appGroup; |
| 45 | + |
| 46 | + /** |
| 47 | + * The SDK connector service. |
| 48 | + * |
| 49 | + * @var \Drupal\apigee_edge\SDKConnectorInterface |
| 50 | + */ |
| 51 | + private $connector; |
| 52 | + |
| 53 | + /** |
| 54 | + * The appgroup membership object cache. |
| 55 | + * |
| 56 | + * @var \Drupal\apigee_edge_teams\AppGroupMembershipObjectCacheInterface |
| 57 | + */ |
| 58 | + private $appGroupMembershipObjectCache; |
| 59 | + |
| 60 | + /** |
| 61 | + * AppGroupMembersController constructor. |
| 62 | + * |
| 63 | + * @param string $appGroup |
| 64 | + * The name of the appgroup. |
| 65 | + * @param \Drupal\apigee_edge\SDKConnectorInterface $connector |
| 66 | + * The SDK connector service. |
| 67 | + * @param \Drupal\apigee_edge_teams\AppGroupMembershipObjectCacheInterface $appgroup_membership_object_cache |
| 68 | + * The appgroup membership object cache. |
| 69 | + */ |
| 70 | + public function __construct(string $appGroup, SDKConnectorInterface $connector, AppGroupMembershipObjectCacheInterface $appgroup_membership_object_cache) { |
| 71 | + $this->appGroup = $appGroup; |
| 72 | + $this->connector = $connector; |
| 73 | + $this->appGroupMembershipObjectCache = $appgroup_membership_object_cache; |
| 74 | + } |
| 75 | + |
| 76 | + /** |
| 77 | + * Returns the decorated appgroup members controller from the SDK. |
| 78 | + * |
| 79 | + * @return \Apigee\Edge\Api\ApigeeX\Controller\AppGroupMembersController |
| 80 | + * The initialized appgroup members controller. |
| 81 | + */ |
| 82 | + private function decorated(): ApigeeXAppGroupMembersController { |
| 83 | + return new ApigeeXAppGroupMembersController($this->appGroup, $this->connector->getOrganization(), $this->connector->getClient()); |
| 84 | + } |
| 85 | + |
| 86 | + /** |
| 87 | + * {@inheritdoc} |
| 88 | + */ |
| 89 | + public function getAppGroup(): string { |
| 90 | + return $this->decorated()->getAppGroup(); |
| 91 | + } |
| 92 | + |
| 93 | + /** |
| 94 | + * Syncs the appgroup team members email and roles in database. |
| 95 | + * |
| 96 | + * @return \Apigee\Edge\Api\ApigeeX\Structure\AppGroupMembership |
| 97 | + * Array of developers with their optional roles in the appgroup. |
| 98 | + */ |
| 99 | + public function syncAppGroupMembers(): AppGroupMembership { |
| 100 | + $membership = $this->decorated()->getMembers(); |
| 101 | + |
| 102 | + $developer_exist = TRUE; |
| 103 | + foreach ($membership->getMembers() as $developer_id => $roles) { |
| 104 | + $roles = is_array($roles) ? $roles : []; |
| 105 | + |
| 106 | + /** @var \Drupal\user\Entity\User $account */ |
| 107 | + $account = user_load_by_mail($developer_id); |
| 108 | + |
| 109 | + if (!$account) { |
| 110 | + $developer_exist = FALSE; |
| 111 | + /** @var \Drupal\apigee_edge_teams\Entity\Storage\TeamInvitationStorageInterface $teamInvitationStorage */ |
| 112 | + $teamInvitationStorage = \Drupal::entityTypeManager()->getStorage('team_invitation'); |
| 113 | + |
| 114 | + $pending_invitations = array_filter($teamInvitationStorage->loadByRecipient($developer_id, $this->appGroup), function (TeamInvitationInterface $team_invitation) { |
| 115 | + return $team_invitation->isPending(); |
| 116 | + }); |
| 117 | + |
| 118 | + // Checking if this developer has already pending invite to prevent multiple invites. |
| 119 | + if (count($pending_invitations) === 0) { |
| 120 | + $teamInvitationStorage->create([ |
| 121 | + 'team' => ['target_id' => $this->appGroup], |
| 122 | + 'team_roles' => array_values(array_map(function (string $role) { |
| 123 | + return ['target_id' => $role]; |
| 124 | + }, $roles)), |
| 125 | + 'recipient' => $developer_id, |
| 126 | + ])->save(); |
| 127 | + } |
| 128 | + } |
| 129 | + else { |
| 130 | + /** @var \Drupal\apigee_edge_teams\Entity\TeamInterface|null $team_entity */ |
| 131 | + $team_entity = \Drupal::entityTypeManager()->getStorage('team')->load($this->appGroup); |
| 132 | + /** @var \Drupal\apigee_edge_teams\Entity\Storage\TeamMemberRoleStorageInterface $team_member_role_storage */ |
| 133 | + $team_member_role_storage = \Drupal::entityTypeManager()->getStorage('team_member_role'); |
| 134 | + $team_member_role_storage->addTeamRoles($account, $team_entity, $roles); |
| 135 | + } |
| 136 | + } |
| 137 | + // Caching the membership only if all the developer exists in Drupal |
| 138 | + // to avoid team member without access. |
| 139 | + if ($developer_exist) { |
| 140 | + $this->appGroupMembershipObjectCache->saveMembership($this->appGroup, $membership); |
| 141 | + } |
| 142 | + |
| 143 | + return $membership; |
| 144 | + } |
| 145 | + |
| 146 | + /** |
| 147 | + * {@inheritdoc} |
| 148 | + */ |
| 149 | + public function getMembers(): AppGroupMembership { |
| 150 | + $membership = $this->appGroupMembershipObjectCache->getMembership($this->appGroup); |
| 151 | + if ($membership === NULL) { |
| 152 | + /** @var \Drupal\apigee_edge_teams\Entity\TeamInterface|null $team_entity */ |
| 153 | + $team_entity = \Drupal::entityTypeManager()->getStorage('team')->load($this->appGroup); |
| 154 | + // Load team_member_role object. |
| 155 | + $team_member_role_storage = \Drupal::entityTypeManager()->getStorage('team_member_role'); |
| 156 | + $members = array_reduce($team_member_role_storage->loadByTeam($team_entity), function ($carry, TeamMemberRoleInterface $developer_role) { |
| 157 | + $carry[$developer_role->getDeveloper()->getEmail()] = $developer_role->getDeveloper()->getEmail(); |
| 158 | + return $carry; |
| 159 | + }, |
| 160 | + []); |
| 161 | + $membership = new AppGroupMembership($members); |
| 162 | + $this->appGroupMembershipObjectCache->saveMembership($team_entity->id(), $membership); |
| 163 | + } |
| 164 | + |
| 165 | + return $membership; |
| 166 | + } |
| 167 | + |
| 168 | + /** |
| 169 | + * {@inheritdoc} |
| 170 | + */ |
| 171 | + public function setMembers(AppGroupMembership $members): AppGroupMembership { |
| 172 | + // Get the existing members and roles from ApigeeX. |
| 173 | + $apigeeReservedMembers = $this->decorated()->getMembers(); |
| 174 | + // Getting all developers including the newly added one. |
| 175 | + $developers = array_merge($apigeeReservedMembers->getMembers(), $members->getMembers()); |
| 176 | + |
| 177 | + foreach ($developers as $developer => $roles) { |
| 178 | + $members->setMember($developer, $roles); |
| 179 | + } |
| 180 | + // Storing membership info on appgroups __apigee_reserved__developer_details attribute for ApigeeX. |
| 181 | + $result = $this->decorated()->setMembers($members); |
| 182 | + |
| 183 | + // Returned membership does not contain all actual members of the appGroup, |
| 184 | + // so it is easier to remove the membership object from the cache and |
| 185 | + // enforce reload in getMembers(). |
| 186 | + $this->appGroupMembershipObjectCache->removeMembership($this->appGroup); |
| 187 | + return $result; |
| 188 | + } |
| 189 | + |
| 190 | + /** |
| 191 | + * {@inheritdoc} |
| 192 | + */ |
| 193 | + public function removeMember(string $email): void { |
| 194 | + // Get the existing members and roles from ApigeeX. |
| 195 | + $apigeeReservedMembers = $this->decorated()->getMembers(); |
| 196 | + |
| 197 | + foreach ($apigeeReservedMembers->getMembers() as $developer => $roles) { |
| 198 | + if ($developer === $email) { |
| 199 | + $apigeeReservedMembers->removeMember($developer); |
| 200 | + } |
| 201 | + } |
| 202 | + // Storing membership info on appgroups __apigee_reserved__developer_details attribute for ApigeeX. |
| 203 | + // Removing and updating the member on appgroups __apigee_reserved__developer_details attribute for ApigeeX. |
| 204 | + $result = $this->decorated()->setMembers($apigeeReservedMembers); |
| 205 | + |
| 206 | + $this->appGroupMembershipObjectCache->removeMembership($this->appGroup); |
| 207 | + } |
| 208 | + |
| 209 | +} |
0 commit comments