diff --git a/Controller/GrouperGroupsController.php b/Controller/GrouperGroupsController.php index b1b67f4..c2b9f69 100644 --- a/Controller/GrouperGroupsController.php +++ b/Controller/GrouperGroupsController.php @@ -1,9 +1,38 @@ request->query['groupname']); - $details = $this->GrouperGroup->groupDescriptions($name); - - $this->set('groupname', $name); $this->set('title', _txt('pl.grouperlite.title.groupinfo')); - $this->set('groupergroupsdetail', $details[0]); - $this->set('isuserowner', $this->GrouperGroup->isUserOwner($this->userId)); + try { + $details = $this->GrouperGroup->groupDescriptions($name); + $this->set('groupergroupsdetail', $details[0]); + + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': ' . var_export($e->getMessage(), true)); + + $this->set('groupergroupsdetail', array()); + $this->Flash->set(_txt('pl.grouperlite.message.flash.info-group-failed'), array('key' => 'error')); + } } + /** + * Listing of all Grouper Groups owned/admin by User Or search those Grouper Groups + */ public function groupOwner() { $this->set('title', _txt('pl.grouperlite.title.groupowner')); - if (isset($this->request->data['search'])){ + + if (isset($this->request->data['search'])) { $searchCriteria = urldecode($this->request->data['search']); - $this->set('groupergroupsowner', $this->GrouperGroup->getSearchedGroups($this->userId, $searchCriteria, 'groupOwner')); $this->set('searchcriteria', $searchCriteria); + + try { + $this->set('groupergroupsowner', $this->GrouperGroup->getSearchedGroups($this->userId, $searchCriteria, 'groupOwner')); + + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ' Search: ' . var_export($e->getMessage(), true)); + + $this->set('groupergroupsowner', array()); + $this->Flash->set(_txt('pl.grouperlite.message.flash.owner-group-failed'), array('key' => 'error')); + return; + } } else { - $this->set('groupergroupsowner', $this->GrouperGroup->ownerGroups($this->userId)); + try { + $this->set('groupergroupsowner', $this->GrouperGroup->ownerGroups($this->userId)); + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': ' . var_export($e->getMessage(), true)); + + $this->set('groupergroupsowner', array()); + $this->Flash->set(_txt('pl.grouperlite.message.flash.owner-group-failed'), array('key' => 'error')); + return; + } + } $this->set('isuserowner', $this->GrouperGroup->isUserOwner($this->userId)); } @@ -91,22 +157,34 @@ public function groupOwner() { */ public function groupMember() { $this->set('title', _txt('pl.grouperlite.title.groupmember')); - try { - if (isset($this->request->data['search'])){ - $searchCriteria = urldecode($this->request->data['search']); + + if (isset($this->request->data['search'])) { + $searchCriteria = urldecode($this->request->data['search']); + $this->set('searchcriteria', $searchCriteria); + + try { $this->set('groupergroupmemberships', $this->GrouperGroup->getSearchedGroups($this->userId, $searchCriteria, 'groupMember')); - $this->set('searchcriteria', $searchCriteria); - } else { + + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ' Search: ' . var_export($e->getMessage(), true)); + + $this->Flash->set("Your Search Group cannot be found, please try again later.", array('key' => 'error')); + $this->set('groupergroupmemberships', array()); + return; + } + } else { + try { $this->set('groupergroupmemberships', $this->GrouperGroup->filteredMemberOfGroups($this->userId)); + + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': ' . var_export($e->getMessage(), true)); + + $this->Flash->set("Your Member Group cannot be found, please try again later.", array('key' => 'error')); + $this->set('groupergroupmemberships', array()); + return; } - } catch (Exception $e) { - CakeLog::write('error', - 'GrouperLite Controller - groupMember: ' . var_export($e->getMessage(), true)); - $this->Flash->set("Your Membership Groups cannot be found currently, please try again later.", array('key' => 'error')); - $this->set('groupergroupmemberships', array()); } $this->set('isuserowner', $this->GrouperGroup->isUserOwner($this->userId)); - } /** @@ -115,24 +193,29 @@ public function groupMember() { public function groupOptin() { $this->set('title', _txt('pl.grouperlite.title.groupoptin')); - if (isset($this->request->data['search'])){ + if (isset($this->request->data['search'])) { $searchCriteria = urldecode($this->request->data['search']); - $this->set('groupergroupoptin', $this->GrouperGroup->getSearchedGroups($this->userId, $searchCriteria, 'groupOptin')); $this->set('searchcriteria', $searchCriteria); + + try { + $this->set('groupergroupoptin', $this->GrouperGroup->getSearchedGroups($this->userId, $searchCriteria, 'groupOptin')); + + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . 'Search: ' . var_export($e->getMessage(), true)); + + $this->Flash->set("Your Optin Group Search cannot be found, please try again later.", array('key' => 'error')); + $this->set('groupergroupoptin', array()); + return; + } } else { try { - $optin = $this->GrouperGroup->optinGroups($this->userId); - if (isset($optin['errorMessage'])){ - $this->Flash->set('Some error', array('key' => 'error')); - $this->set('groupergroupoptin', array()); - } else { - $this->set('groupergroupoptin', $optin); - } + $this->set('groupergroupoptin', $this->GrouperGroup->optinGroups($this->userId)); } catch (Exception $e) { - CakeLog::write('error', 'GrouperLite Controller: Seeing is believing'); - $this->Flash->set($e->getMessage(), array('key' => 'error')); + CakeLog::write('error', __METHOD__ . ': ' . var_export($e->getMessage(), true)); + $this->Flash->set("An error occurred with the Optin Groups, please try again later.", array('key' => 'error')); $this->set('groupergroupoptin', array()); + return; } } $this->set('isuserowner', $this->GrouperGroup->isUserOwner($this->userId)); @@ -161,10 +244,15 @@ public function joinGroup() { if ($this->request->is('post')) { $name = $this->request->data['GroupName']; - if($this->GrouperGroup->joinGroup($this->userId, $name)) { - $this->Flash->set(_txt('pl.grouperlite.message.flash.join-group-success'), array('key' => 'success')); - } else { - $this->Flash->set(_txt('pl.grouperlite.message.flash.join-group-failed'), array('key' => 'error')); + try { + if ($this->GrouperGroup->joinGroup($this->userId, $name)) { + $this->Flash->set(_txt('pl.grouperlite.message.flash.join-group-success'), array('key' => 'success')); + } else { + $this->Flash->set(_txt('pl.grouperlite.message.flash.join-group-failed'), array('key' => 'error')); + } + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': ' . var_export($e->getMessage(), true)); + $this->Flash->set(_txt('pl.grouperlite.message.flash.join-group-error'), array('key' => 'error')); } } else { @@ -183,11 +271,17 @@ public function leaveGroup() { if ($this->request->is('post')) { $name = $this->request->data['GroupName']; - if($this->GrouperGroup->leaveGroup($this->userId, $name)) { - $this->Flash->set(_txt('pl.grouperlite.message.flash.leave-group-success'), array('key' => 'success')); - } else { - $this->Flash->set(_txt('pl.grouperlite.message.flash.leave-group-failed'), array('key' => 'error')); + try { + if ($this->GrouperGroup->leaveGroup($this->userId, $name)) { + $this->Flash->set(_txt('pl.grouperlite.message.flash.leave-group-success'), array('key' => 'success')); + } else { + $this->Flash->set(_txt('pl.grouperlite.message.flash.leave-group-failed'), array('key' => 'error')); + } + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': ' . var_export($e->getMessage(), true)); + $this->Flash->set(_txt('pl.grouperlite.message.flash.leave-group-error'), array('key' => 'error')); } + } else { $this->Flash->set(_txt('pl.grouperlite.message.flash.leave-group-error'), array('key' => 'error')); } @@ -203,14 +297,14 @@ public function leaveGroup() { * - precondition: Session.Auth holds data used for authz decisions * - postcondition: $permissions set with calculated permissions * - * @since COmanage Registry v3.2.0 * @return Array Permissions + * @since COmanage Registry v3.2.0 */ function isAuthorized() { $roles = $this->Role->calculateCMRoles(); //Need to pull in UserID for access to Grouper - if($this->Session->check('Auth.User.username')) { + if ($this->Session->check('Auth.User.username')) { $this->userId = $this->Session->read('Auth.User.username'); } @@ -276,5 +370,4 @@ public function emailListInfo() { 'attributes' => array() )); } - } diff --git a/Lib/GrouperApiAccess.php b/Lib/GrouperApiAccess.php index f451c5e..81377e5 100644 --- a/Lib/GrouperApiAccess.php +++ b/Lib/GrouperApiAccess.php @@ -57,7 +57,7 @@ public function __construct() { $this->http = new GrouperHTTPWrapper(); if (!CakeSession::check('Plugin.Grouper.Api.id')) { - CakeLog::write('error', 'GrouperLite API: No Widget record in Session'); + CakeLog::write('error', __METHOD__ . ': No Widget record in Session'); throw new GrouperLiteException("No GrouperLite instance captured"); } @@ -110,8 +110,7 @@ public function getGrouperUser(array $queryData) { } } catch (Exception $e) { - CakeLog::write('error', - 'GrouperLite API - getGrouperUser: An issue surfaced of ' . var_export($e->getMessage(), true)); + CakeLog::write('error', __METHOD__ . ': An error occurred'); throw $e; } @@ -139,8 +138,7 @@ public function getGrouperMemberOfGroups(array $queryData) { return $results['WsGetGroupsLiteResult']['wsGroups']; } } catch (Exception $e) { - CakeLog::write('error', - 'GrouperLite API - getGrouperMemberOfGroups: An issue surfaced of ' . var_export($e->getMessage(), true)); + CakeLog::write('error', __METHOD__ . ': An error occurred'); throw $e; } @@ -170,8 +168,7 @@ public function grouperGroupLeaveOrJoin(array $queryData) { $resultResponse = 'WsAddMemberResults'; $resultGroup = 'wsGroupAssigned'; } else { - CakeLog::write('error', - "GrouperLite API - grouperGroupLeaveOrJoin: Option of $groupLeaveOrJoin is not supported"); + CakeLog::write('error',__METHOD__ . ": Option of $groupLeaveOrJoin is not supported"); throw new GrouperLiteException("Receved option of $groupLeaveOrJoin which is not supported"); } @@ -187,6 +184,7 @@ public function grouperGroupLeaveOrJoin(array $queryData) { ) ) ); + $this->http->setHeader(array('Content-Type' => 'application/json', 'Accept' => 'application/json')); $connectionUrl = "{$this->config['fullUrl']}/groups/{$groupName}/members"; @@ -200,8 +198,7 @@ public function grouperGroupLeaveOrJoin(array $queryData) { } } } catch (Exception $e) { - CakeLog::write('error', - 'GrouperLite API - grouperGroupLeaveOrJoin: An issue surfaced of ' . var_export($e->getMessage(), true)); + CakeLog::write('error', __METHOD__ . ': An error occurred'); throw $e; } @@ -228,8 +225,7 @@ public function getOptinGroups(array $queryData) { return $results['WsGetMembershipsResults']['wsGroups']; } } catch (Exception $e) { - CakeLog::write('error', - 'GrouperLite API - getOptinGroups: An issue surfaced of ' . var_export($e->getMessage(), true)); + CakeLog::write('error', __METHOD__ . ': An error occurred'); throw $e; } return array(); @@ -253,8 +249,7 @@ public function getOwnerGroups(array $queryData) { return $results['WsGetMembershipsResults']['wsGroups']; } } catch (Exception $e) { - CakeLog::write('error', - 'GrouperLite API - getOwnerGroups: An issue surfaced of ' . var_export($e->getMessage(), true)); + CakeLog::write('error', __METHOD__ . ': An error occurred'); throw $e; } return array(); @@ -277,8 +272,7 @@ public function getOwnerStems(array $queryData) { return $results['WsGetMembershipsResults']['wsStems']; } } catch (Exception $e) { - CakeLog::write('error', - 'GrouperLite API - getOwnerStems: An issue surfaced of ' . var_export($e->getMessage(), true)); + CakeLog::write('error', __METHOD__ . ': An error occurred'); throw $e; } return array(); @@ -309,8 +303,7 @@ private function useMembershipUrl(array $queryData) { $fieldName = "stemAdmin"; $subjectId = $userId; } else { - CakeLog::write('error', - "GrouperLite API - useMembershipUrl: Option of $groupType is not supported"); + CakeLog::write('error', __METHOD__ . ": Option of $groupType is not supported"); throw new GrouperLiteException("Option of $groupType is not supported"); } @@ -329,14 +322,13 @@ private function useMembershipUrl(array $queryData) { try { return $this->http->sendRequest('POST', $connectionUrl, json_encode($groupsToShow)); } catch (Exception $e) { - CakeLog::write('error', - 'GrouperLite API - useMembershipUrl: An issue surfaced of ' . var_export($e->getMessage(), true)); + CakeLog::write('error', __METHOD__ . ': An error occurred'); throw $e; } } /** - * Returns a Distinct Grouper Group with its associated attributes and values + * Returns a Distinct Grouper Group with its associated values * * @param array $queryData Array of conditions for querying * @return array Array of attributes for a Group @@ -356,8 +348,7 @@ public function getGrouperGroupDescription(array $queryData) { return $results['WsGetMembershipsResults']['wsGroups']; } } catch (Exception $e) { - CakeLog::write('error', - 'GrouperLite API - getGrouperGroupDescription: An issue surfaced of ' . var_export($e->getMessage(), true)); + CakeLog::write('error', __METHOD__ . ': An error occurred'); throw $e; } return array(); @@ -414,8 +405,7 @@ public function createUpdateGroup(array $queryData) { } } } catch (Exception $e) { - CakeLog::write('error', - 'GrouperLite API - createUpdateGroup: An issue surfaced of ' . var_export($e->getMessage(), true)); + CakeLog::write('error', __METHOD__ . ': An error occurred'); throw $e; } return false; @@ -454,8 +444,7 @@ public function getGroupAttributes(array $queryData) { return $results['WsGetAttributeAssignmentsResults']['wsAttributeAssigns']; } } catch (Exception $e) { - CakeLog::write('error', - 'GrouperLite API - getGroupAttributes: An issue surfaced of ' . var_export($e->getMessage(), true)); + CakeLog::write('error', __METHOD__ . ': An error occurred'); throw $e; } return array(); diff --git a/Lib/GrouperHTTPWrapper.php b/Lib/GrouperHTTPWrapper.php index 9c9abb9..625d96c 100644 --- a/Lib/GrouperHTTPWrapper.php +++ b/Lib/GrouperHTTPWrapper.php @@ -115,8 +115,7 @@ public function sendRequest(string $method, string $uri, string $body = ''): arr try { $results = $this->request($this->_request); } catch (Exception $e) { - CakeLog::write('error', - 'GrouperLite API: An error occurred: ' . var_export($e->getMessage(), true)); + CakeLog::write('error', __METHOD__ . ': An error occurred: ' . var_export($e->getMessage(), true)); throw new GrouperLiteException('An error occurred talking to Grouper WS'); } return $this->_verifyResults($results); @@ -139,15 +138,12 @@ private function _verifyResults(HttpSocketResponse $apiResults): array { $apiSuccess = $resBody[$mainKey]['resultMetadata']['resultCode']; if ($apiSuccess != 'SUCCESS') { - CakeLog::write('error', - 'GrouperLite: Result Code was not SUCCESS, it was: ' . var_export($apiSuccess, true)); - CakeLog::write('error', - 'GrouperLite: Error message: ' . var_export($apiResults->body(), true)); + CakeLog::write('error', __METHOD__ . ': Result Code was ' . var_export($apiSuccess, true)); + CakeLog::write('error', __METHOD__ . ': Error of ' . var_export($apiResults->body(), true)); throw new GrouperLiteException('Result from Grouper WS was' . var_export($apiSuccess, true)); } } else { - CakeLog::write('error', - 'GrouperLite Verify: Error message = ' . var_export($apiResults->body(), true)); + CakeLog::write('error', __METHOD__ . ': Verify error of ' . var_export($apiResults->body(), true)); throw new GrouperLiteException('An error occurred while talking to Grouper WS'); } return $resBody; diff --git a/Lib/lang.php b/Lib/lang.php index 60baf2d..b52f529 100644 --- a/Lib/lang.php +++ b/Lib/lang.php @@ -1,75 +1,80 @@ 'Grouper Configuration Settings', - 'pl.grouperlite.config.edit.title' => 'Edit Grouper Configuration Settings', - 'pl.grouperlite.config.grouper-url' => 'Grouper URL', - 'pl.grouperlite.config.grouper-version' => 'Grouper Version', - 'pl.grouperlite.config.grouper-un' => 'Username', - 'pl.grouperlite.config.grouper-pw' => 'Password', + 'pl.grouperlite.config.display.title' => 'Grouper Configuration Settings', + 'pl.grouperlite.config.edit.title' => 'Edit Grouper Configuration Settings', + 'pl.grouperlite.config.grouper-url' => 'Grouper URL', + 'pl.grouperlite.config.grouper-version' => 'Grouper Version', + 'pl.grouperlite.config.grouper-un' => 'Username', + 'pl.grouperlite.config.grouper-pw' => 'Password', - 'pl.grouperlite.crumb.root' => 'Grouper', - 'pl.grouperlite.nav.groups-can-join' => 'Groups I can join', - 'pl.grouperlite.nav.groups-presided' => 'Groups I manage', - 'pl.grouperlite.nav.memberships' => 'My memberships', - 'pl.grouperlite.nav.email-lists' => 'Email lists', - 'pl.grouperlite.nav.email-lists-managed' => 'Email lists I manage', - 'pl.grouperlite.nav.create-group' => 'Create group', + 'pl.grouperlite.crumb.root' => 'Grouper', + 'pl.grouperlite.nav.groups-can-join' => 'Groups I can join', + 'pl.grouperlite.nav.groups-presided' => 'Groups I manage', + 'pl.grouperlite.nav.memberships' => 'My memberships', + 'pl.grouperlite.nav.email-lists' => 'Email lists', + 'pl.grouperlite.nav.email-lists-managed' => 'Email lists I manage', + 'pl.grouperlite.nav.create-group' => 'Create group', - 'pl.grouperlite.title.root' => 'Grouper Collaborations:', - 'pl.grouperlite.title.groupinfo' => 'Group configuration and attributes', - 'pl.grouperlite.title.groupowner' => 'Groups I manage', - 'pl.grouperlite.title.groupmember' => 'My Memberships', - 'pl.grouperlite.title.groupoptin' => 'Groups I can join', - 'pl.grouperlite.title.emaillists' => 'Email lists', - 'pl.grouperlite.title.emaillistsmanaged' => 'Email lists I manage', - 'pl.grouperlite.title.emaillistsinfo' => 'Email list configuration and attributes', - 'pl.grouperlite.title.groupcreate' => 'Create Group', + 'pl.grouperlite.title.root' => 'Grouper Collaborations:', + 'pl.grouperlite.title.groupinfo' => 'Group configuration and attributes', + 'pl.grouperlite.title.groupowner' => 'Groups I manage', + 'pl.grouperlite.title.groupmember' => 'My Memberships', + 'pl.grouperlite.title.groupoptin' => 'Groups I can join', + 'pl.grouperlite.title.emaillists' => 'Email lists', + 'pl.grouperlite.title.emaillistsmanaged' => 'Email lists I manage', + 'pl.grouperlite.title.emaillistsinfo' => 'Email list configuration and attributes', + 'pl.grouperlite.title.groupcreate' => 'Create Group', - 'pl.grouperlite.message.flash.join-group-success' => 'You have been added to the group!', - 'pl.grouperlite.message.flash.join-group-failed' => 'You are unable to join the group!', - 'pl.grouperlite.message.flash.join-group-error' => 'An error occurred in joining the group, please try again later.', + 'pl.grouperlite.message.flash.join-group-success' => 'You have been added to the group!', + 'pl.grouperlite.message.flash.join-group-failed' => 'You are unable to join the group!', + 'pl.grouperlite.message.flash.join-group-error' => 'An error occurred in joining the group, please try again later.', + 'pl.grouperlite.message.flash.info-group-failed' => 'Error in viewing group info, please try again later.', - 'pl.grouperlite.message.flash.leave-group-success' => 'You have been deleted from the group!', - 'pl.grouperlite.message.flash.leave-group-failed' => 'You are unable to delete the group!', - 'pl.grouperlite.message.flash.leave-group-error' => 'An error occurred in leaving the group, please try again later.', + 'pl.grouperlite.message.flash.leave-group-success' => 'You have been deleted from the group!', + 'pl.grouperlite.message.flash.leave-group-failed' => 'You are unable to delete the group!', + 'pl.grouperlite.message.flash.leave-group-error' => 'An error occurred in leaving the group, please try again later.', + 'pl.grouperlite.message.flash.owner-group-failed' => 'Error occurred in viewing groups you manage, please try again later.', + 'pl.grouperlite.message.flash.member-group-failed' => 'Error occurred in viewing groups you are a member, please try again later.', + 'pl.grouperlite.message.flash.optin-group-failed' => 'Error occurred in viewing Optin groups, please try again later.', - 'pl.grouperlite.table.name' => 'Name', - 'pl.grouperlite.table.description' => 'Description', - 'pl.grouperlite.table.status' => 'Status', - 'pl.grouperlite.table.action' => 'Action', - 'pl.grouperlite.value.descr.zerostate' => 'No Description', - 'pl.grouperlite.value.enabled' => 'Enabled', - 'pl.grouperlite.value.disabled' => 'Disabled', + 'pl.grouperlite.table.name' => 'Name', + 'pl.grouperlite.table.description' => 'Description', + 'pl.grouperlite.table.status' => 'Status', + 'pl.grouperlite.table.action' => 'Action', - 'pl.grouperlite.action.join-group' => 'Join group', - 'pl.grouperlite.action.leave-group' => 'Leave group', - 'pl.grouperlite.action.edit-group' => 'Edit', - 'pl.grouperlite.action.disable-group' => 'Disable', - 'pl.grouperlite.action.subscribe' => 'Subscribe', - 'pl.grouperlite.action.unsubscribe' => 'Unsubscribe', - 'pl.grouperlite.action.search' => 'Search', - 'pl.grouperlite.action.remove' => 'Remove', + 'pl.grouperlite.value.descr.zerostate' => 'No Description', + 'pl.grouperlite.value.enabled' => 'Enabled', + 'pl.grouperlite.value.disabled' => 'Disabled', - 'pl.grouperlite.form.group.template.label' => 'Select a template', - 'pl.grouperlite.form.group.template.empty' => '(choose one)', - 'pl.grouperlite.form.group.name.label' => 'Display name', - 'pl.grouperlite.form.group.name.help' => 'Name is the label that identifies this group, and might change.', - 'pl.grouperlite.form.group.stem.label' => 'Create in this folder:', - 'pl.grouperlite.form.group.stem.help' => 'Enter a folder name.', - 'pl.grouperlite.form.group.description.label' => 'Description:', - 'pl.grouperlite.form.group.description.help' => 'Description contains notes about the group, which could include: what the group represents, why it was created, etc.', - 'pl.grouperlite.form.group.privs.label' => 'Privileges', - 'pl.grouperlite.form.group.privs.label.READ' => 'READ', - 'pl.grouperlite.form.group.privs.label.VIEW' => 'VIEW', - 'pl.grouperlite.form.group.privs.label.OPTIN' => 'OPTIN', - 'pl.grouperlite.form.group.privs.label.OPTOUT' => 'OPTOUT', - 'pl.grouperlite.form.group.privs.label.ATTRIBUTE_READ' => 'ATTRIBUTE READ', - 'pl.grouperlite.form.group.subs.label' => 'Subscribers:', - 'pl.grouperlite.form.group.subs.help' => 'Select subscribers to add to the group.', - 'pl.grouperlite.form.group.subs.placeholder' => 'Search subscribers', - 'pl.grouperlite.form.group.action.save' => 'Save Group', + 'pl.grouperlite.action.join-group' => 'Join group', + 'pl.grouperlite.action.leave-group' => 'Leave group', + 'pl.grouperlite.action.edit-group' => 'Edit', + 'pl.grouperlite.action.disable-group' => 'Disable', + 'pl.grouperlite.action.subscribe' => 'Subscribe', + 'pl.grouperlite.action.unsubscribe' => 'Unsubscribe', + 'pl.grouperlite.action.search' => 'Search', + 'pl.grouperlite.action.remove' => 'Remove', - 'pl.grouperlite.search.tags.text' => 'Search', + 'pl.grouperlite.form.group.template.label' => 'Select a template', + 'pl.grouperlite.form.group.template.empty' => '(choose one)', + 'pl.grouperlite.form.group.name.label' => 'Display name', + 'pl.grouperlite.form.group.name.help' => 'Name is the label that identifies this group, and might change.', + 'pl.grouperlite.form.group.stem.label' => 'Create in this folder:', + 'pl.grouperlite.form.group.stem.help' => 'Enter a folder name.', + 'pl.grouperlite.form.group.description.label' => 'Description:', + 'pl.grouperlite.form.group.description.help' => 'Description contains notes about the group, which could include: what the group represents, why it was created, etc.', + 'pl.grouperlite.form.group.privs.label' => 'Privileges', + 'pl.grouperlite.form.group.privs.label.READ' => 'READ', + 'pl.grouperlite.form.group.privs.label.VIEW' => 'VIEW', + 'pl.grouperlite.form.group.privs.label.OPTIN' => 'OPTIN', + 'pl.grouperlite.form.group.privs.label.OPTOUT' => 'OPTOUT', + 'pl.grouperlite.form.group.privs.label.ATTRIBUTE_READ' => 'ATTRIBUTE READ', + 'pl.grouperlite.form.group.subs.label' => 'Subscribers:', + 'pl.grouperlite.form.group.subs.help' => 'Select subscribers to add to the group.', + 'pl.grouperlite.form.group.subs.placeholder' => 'Search subscribers', + 'pl.grouperlite.form.group.action.save' => 'Save Group', + + 'pl.grouperlite.search.tags.text' => 'Search', ); \ No newline at end of file diff --git a/Model/CoGrouperLite.php b/Model/CoGrouperLite.php index 154c0e6..a0798e3 100644 --- a/Model/CoGrouperLite.php +++ b/Model/CoGrouperLite.php @@ -42,39 +42,33 @@ class CoGrouperLite extends CoDashboardWidgetBackend { public $hasMany = array( ); + /* + Not sure if will use public $duplicatableModels = array( "CoGrouperLite" => array( "parent" => "CoDashboardWidget", "fk" => "co_dashboard_widget_id" ) - ); + );*/ // Validation rules for table elements + //Tried adding rule to each field to make alphaNumeric, but keeps throwing errors. will research. public $validate = array( 'co_dashboard_widget_id' => array( 'rule' => 'numeric', - 'required' => true, - 'allowEmpty' => false + 'required' => true ), 'connUrl' => array( - 'rule' => 'alphaNumeric', - 'required' => true, - 'allowEmpty' => false + 'required' => true ), 'connVer' => array( - 'rule' => 'alphaNumeric', - 'required' => true, - 'allowEmpty' => false + 'required' => true ), 'connUser' => array( - 'rule' => 'alphaNumeric', - 'required' => true, - 'allowEmpty' => false + 'required' => true ), 'connPass' => array( - 'rule' => 'alphaNumeric', - 'required' => true, - 'allowEmpty' => false + 'required' => true ), ); diff --git a/Model/GrouperAttribute.php b/Model/GrouperAttribute.php index f57c2fb..80f716b 100644 --- a/Model/GrouperAttribute.php +++ b/Model/GrouperAttribute.php @@ -60,10 +60,16 @@ private function initApi() { public function getGroupAttributes(string $groupName) { $this->initApi(); - $args = array(); - $args['conditions']['groupName'] = $groupName; + try { + $args = array(); + $args['conditions']['groupName'] = $groupName; - return $this->grouperAPI->getGroupAttributes($args); + return $this->grouperAPI->getGroupAttributes($args); + + } catch (Exception $e) { + CakeLog::write('error', 'GrouperLite Attribute Model - getGroupAttributes: An error occurred'); + throw $e; + } } } diff --git a/Model/GrouperGroup.php b/Model/GrouperGroup.php index 017677c..72e814e 100644 --- a/Model/GrouperGroup.php +++ b/Model/GrouperGroup.php @@ -74,17 +74,23 @@ public function isUserOwner(string $userId) { $this->initApi(); - $args = array(); - $args['conditions']['userId'] = $userId; + try { + $args = array(); + $args['conditions']['userId'] = $userId; - $ownGroups = $this->grouperAPI->getOwnerGroups($args); + $ownGroups = $this->grouperAPI->getOwnerGroups($args); - if (count($ownGroups) > 0) { - CakeSession::write('Plugin.Grouper.isUserOwner', 'T'); - return 'T'; + if (count($ownGroups) > 0) { + CakeSession::write('Plugin.Grouper.isUserOwner', 'T'); + return 'T'; + } + CakeSession::write('Plugin.Grouper.isUserOwner', 'F'); + return 'F'; + + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': An error occurred'); + throw $e; } - CakeSession::write('Plugin.Grouper.isUserOwner', 'F'); - return 'F'; } /** @@ -111,26 +117,31 @@ private function resetUserOwner() { public function filteredMemberOfGroups(string $userId) { $this->initApi(); - $memberOfGroups = $this->memberOfGroups($userId); - - $args = array(); - $args['conditions']['userId'] = $userId; - // Determine which groups can be left by user, if want. - $optInGroups = $this->grouperAPI->getOptinGroups($args); - - foreach($memberOfGroups as &$memberOfGroup) { - foreach($optInGroups as $key => $value) { - if ($value['name'] == $memberOfGroup['name']) { - //Match! - $memberOfGroup['optedin'] = true; - //Remove Optin group since already found and now less loops - unset($optInGroups[$key]); - break; + try { + $memberOfGroups = $this->memberOfGroups($userId); + + $args = array(); + $args['conditions']['userId'] = $userId; + // Determine which groups can be left by user, if want. + $optInGroups = $this->grouperAPI->getOptinGroups($args); + + foreach($memberOfGroups as &$memberOfGroup) { + foreach($optInGroups as $key => $value) { + if ($value['name'] == $memberOfGroup['name']) { + //Match! + $memberOfGroup['optedin'] = true; + //Remove Optin group since already found and now less loops + unset($optInGroups[$key]); + break; + } } } - } + return $this->getFriendlyName($memberOfGroups); - return $this->getFriendlyName($memberOfGroups); + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': An error occurred'); + throw $e; + } } /** @@ -143,33 +154,54 @@ public function filteredMemberOfGroups(string $userId) { */ private function memberOfGroups(string $userId) { - $args = array(); - $args['conditions']['userId'] = $userId; + try { + $args = array(); + $args['conditions']['userId'] = $userId; - return $this->grouperAPI->getGrouperMemberOfGroups($args); + return $this->grouperAPI->getGrouperMemberOfGroups($args); + + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': An error occurred'); + throw $e; + } } - public function groupDescriptions($groupName) { + /** + * Gets the Grouper Groups params and values as well as its associated attributes. + * + * @param string $groupName Name of Group, do not confuse with DisplayName field! + * @return array An set of attributes associated to a specific Grouper Group + * @throws GrouperLiteException + */ + public function groupDescriptions(string $groupName) { $this->initApi(); - $args = array(); - $args['conditions']['groupName'] = $groupName; + try { + $args = array(); + $args['conditions']['groupName'] = $groupName; + + $groupDescription = $this->grouperAPI->getGrouperGroupDescription($args); + $groupInfo = $this->getFriendlyName($groupDescription); - $groupDescription = $this->grouperAPI->getGrouperGroupDescription($args); - //make call to get attributes for group - $grouperAtt = new GrouperAttribute(); - $groupAttributes = $grouperAtt->getGroupAttributes($groupName); + //make call to get attributes for group + $grouperAtt = new GrouperAttribute(); + $groupAttributes = $grouperAtt->getGroupAttributes($groupName); - $groupDescription[0]["attributes"] = $groupAttributes; + $groupInfo[0]["attributes"] = $groupAttributes; + return $groupInfo; + + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': An error occurred'); + throw $e; + } - return $groupDescription; } /** * Process for User to Leave a Group * * @param string $userId Id of User - * @param string $groupName Name of Group Leaving + * @param string $groupName Name of Group Leaving, do not confuse with DisplayName field! * @return bool True|False * @throws GrouperLiteException * @@ -177,19 +209,25 @@ public function groupDescriptions($groupName) { public function leaveGroup(string $userId, string $groupName) { $this->initApi(); - $args = array(); - $args['conditions']['LeaveJoin'] = 'Leave'; - $args['conditions']['userId'] = $userId; - $args['conditions']['groupName'] = $groupName; + try { + $args = array(); + $args['conditions']['LeaveJoin'] = 'Leave'; + $args['conditions']['userId'] = $userId; + $args['conditions']['groupName'] = $groupName; - return $this->grouperAPI->grouperGroupLeaveOrJoin($args); + return $this->grouperAPI->grouperGroupLeaveOrJoin($args); + + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': An error occurred'); + throw $e; + } } /** * Process for User to Join a Group * * @param string $userId Id of User - * @param string $groupName Name of Group Leaving + * @param string $groupName Name of Group Joining, do not confuse with DisplayName field! * @return bool True|False * @throws GrouperLiteException * @@ -197,30 +235,46 @@ public function leaveGroup(string $userId, string $groupName) { public function joinGroup(string $userId, string $groupName) { $this->initApi(); - $args = array(); - $args['conditions']['LeaveJoin'] = 'Join'; - $args['conditions']['userId'] = $userId; - $args['conditions']['groupName'] = $groupName; + try { + $args = array(); + $args['conditions']['LeaveJoin'] = 'Join'; + $args['conditions']['userId'] = $userId; + $args['conditions']['groupName'] = $groupName; - return $this->grouperAPI->grouperGroupLeaveOrJoin($args); - } + return $this->grouperAPI->grouperGroupLeaveOrJoin($args); + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': An error occurred'); + throw $e; + } + } - public function ownerGroups($userId) { + /** + * Return all Grouper Groups that the User has a role of owner/admin + * + * @param string $userId + * @return array + * @throws GrouperLiteException + * + */ + public function ownerGroups(string $userId) { $this->initApi(); - $args = array(); - $args['conditions']['userId'] = $userId; - - $ownGroups = $this->grouperAPI->getOwnerGroups($args); - $ownerGroups = $this->getFriendlyName($ownGroups); + try { + $args = array(); + $args['conditions']['userId'] = $userId; - return $ownerGroups; + $ownGroups = $this->grouperAPI->getOwnerGroups($args); + return $this->getFriendlyName($ownGroups); + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': An error occurred'); + throw $e; + } } /** - * Display all Groups the User can JOIN + * Return all Groups the User can JOIN * Get all Groups with Optin attribute set and display ones User can join. * Will Match up with Groups User is already a member of to determine which Optin groups to not display * @@ -231,50 +285,85 @@ public function ownerGroups($userId) { public function optinGroups(string $userId) { $this->initApi(); - $args = array(); - $args['conditions']['userId'] = $userId; - - $joinOrLeave = $this->grouperAPI->getOptinGroups($args); - $userGroups = $this->memberOfGroups($userId); - - //See if Optin group match any of the groups user already belongs to. - foreach ($joinOrLeave as $key => $value) { - foreach ($userGroups as $userGroup) { - if ($value['name'] == $userGroup['name']) { - //Match!! - //Removing as already a member of. - unset($joinOrLeave[$key]); - break; + try { + $args = array(); + $args['conditions']['userId'] = $userId; + + $joinOrLeave = $this->grouperAPI->getOptinGroups($args); + $userGroups = $this->memberOfGroups($userId); + + //See if Optin group match any of the groups user already belongs to. + foreach ($joinOrLeave as $key => $value) { + foreach ($userGroups as $userGroup) { + if ($value['name'] == $userGroup['name']) { + //Match!! + //Removing as already a member of. + unset($joinOrLeave[$key]); + break; + } } } - } + return $this->getFriendlyName($joinOrLeave); - return $this->getFriendlyName($joinOrLeave); + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': An error occurred'); + throw $e; + } } - public function createGroup($userId, $groupName, $stemName, $groupDesc) { + /** + * Creates a new Grouper Group + * + * @param string $userId Id of user + * @param string $groupName Display Name of Group creating, do not confuse with Name field that is ID! + * @param string $stemName Full Stem (Folder) Name in format of 'stem:substem:subsubstem' + * @param string $groupDesc Description of Group creating + * @return bool True if saved | False if already created + * @throws GrouperLiteException + * + */ + public function createGroup(string $userId, string $groupName, string $stemName, string $groupDesc) { $this->initApi(); - $args = array(); - $args['conditions']['groupType'] = 'Optins'; - $args['conditions']['userId'] = $userId; - $args['conditions']['groupName'] = $groupName; - $args['conditions']['stemName'] = $stemName; - $args['conditions']['groupDescription'] = $groupDesc; + try { + $args = array(); + $args['conditions']['groupType'] = 'Optins'; + $args['conditions']['userId'] = $userId; + $args['conditions']['groupName'] = $groupName; + $args['conditions']['stemName'] = $stemName; + $args['conditions']['groupDescription'] = $groupDesc; - // Reset Session variable holding if User is an owner - $this->resetUserOwner(); + // Reset Session variable that shows if User is an owner or not + $this->resetUserOwner(); - return $this->grouperAPI->createUpdateGroup($args); + return $this->grouperAPI->createUpdateGroup($args); + + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': An error occurred'); + throw $e; + } } - public function getOwnerStems($userId) { + /** + * Get Grouper Stems where User has authority to create a Grouper Group + * + * @param string $userId Id of User + * @return array Stem records + * @throws GrouperLiteException + */ + public function getOwnerStems(string $userId) { $this->initApi(); - $args = array(); - $args['conditions']['userId'] = $userId; + try { + $args = array(); + $args['conditions']['userId'] = $userId; - return $this->grouperAPI->getOwnerStems($args); + return $this->grouperAPI->getOwnerStems($args); + + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': An error occurred'); + throw $e; + } } /** @@ -283,35 +372,42 @@ public function getOwnerStems($userId) { * functionality. This is due to the fact that the grouperName is autogenerated and this app needs to search * attributes which the Grouper WS does not do. * - * @param $userId - * @param $searchCriteria - * @param $page - * @return array + * @param string $userId Id of User + * @param string $searchCriteria Search term entered by user + * @param string $page Page where search was executed, so can search correct criteria + * @return array Records that meet search criteria * @throws GrouperLiteException Captured in Controller */ - public function getSearchedGroups($userId, $searchCriteria, $page) { + public function getSearchedGroups(string $userId, string $searchCriteria, string $page) { $this->initApi(); - if($page == 'groupOptin') { - $pageResults = $this->optinGroups($userId); - } elseif ($page == 'groupOwner') { - $pageResults = $this->ownerGroups($userId); - } elseif ($page == 'groupMember') { - $pageResults = $this->filteredMemberOfGroups($userId); - } else { - $pageResults = array(); - } + try { + // Current list of views that search can be executed from + if($page == 'groupOptin') { + $pageResults = $this->optinGroups($userId); + } elseif ($page == 'groupOwner') { + $pageResults = $this->ownerGroups($userId); + } elseif ($page == 'groupMember') { + $pageResults = $this->filteredMemberOfGroups($userId); + } else { + $pageResults = array(); + } - $returnResults = array(); + $returnResults = array(); - foreach($pageResults as $result) { - $match = preg_grep("/$searchCriteria/i", $result); - if (!empty($match)) { - $returnResults[] = $result; + foreach($pageResults as $result) { + $match = preg_grep("/$searchCriteria/i", $result); + if (!empty($match)) { + $returnResults[] = $result; + } } - } - return $returnResults; + return $returnResults; + + } catch (Exception $e) { + CakeLog::write('error', __METHOD__ . ': An error occurred'); + throw $e; + } } /** diff --git a/View/CoGrouperLites/fields.inc b/View/CoGrouperLites/fields.inc index 7bdff65..3811a43 100644 --- a/View/CoGrouperLites/fields.inc +++ b/View/CoGrouperLites/fields.inc @@ -204,6 +204,6 @@ print $this->Form->hidden('co_dashboard_widget_id', array('default' => $vv_dwid)
-

+

\ No newline at end of file diff --git a/View/GrouperGroups/groupinfo.ctp b/View/GrouperGroups/groupinfo.ctp index c74a6b6..f20f1cc 100644 --- a/View/GrouperGroups/groupinfo.ctp +++ b/View/GrouperGroups/groupinfo.ctp @@ -13,7 +13,7 @@ $isuserowner = 'T';
-

Group:

+

Group: