UserGridHandler.inc.php

<?php
 
import('lib.pkp.classes.controllers.grid.GridHandler');
import('lib.pkp.classes.controllers.grid.DataObjectGridCellProvider');
 
import('lib.pkp.controllers.grid.settings.user.UserGridRow');
import('lib.pkp.controllers.grid.settings.user.form.UserDetailsForm');
 
class UserGridHandler extends GridHandler {
   var $_oldUserId;
 
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(array(
         ROLE_ID_MANAGER, ROLE_ID_SITE_ADMIN),
         array('fetchGrid', 'fetchRow', 'editUser', 'updateUser', 'updateUserRoles',
            'editDisableUser', 'disableUser', 'removeUser', 'addUser',
            'editEmail', 'sendEmail', 'mergeUsers')
      );
   }
 
 
   //
   // Implement template methods from PKPHandler.
   //
   function authorize($request, &$args, $roleAssignments) {
      import('lib.pkp.classes.security.authorization.ContextAccessPolicy');
      $this->addPolicy(new ContextAccessPolicy($request, $roleAssignments));
      return parent::authorize($request, $args, $roleAssignments);
   }
 
   function initialize($request, $args = null) {
      parent::initialize($request, $args);
 
      // Load user-related translations.
      AppLocale::requireComponents(
         LOCALE_COMPONENT_PKP_USER,
         LOCALE_COMPONENT_PKP_MANAGER,
         LOCALE_COMPONENT_APP_MANAGER
      );
 
      $this->_oldUserId  = (int) $request->getUserVar('oldUserId');
      // Basic grid configuration.
      $this->setTitle('grid.user.currentUsers');
 
      // Grid actions.
      $router = $request->getRouter();
 
      import('lib.pkp.classes.linkAction.request.AjaxModal');
      $this->addAction(
         new LinkAction(
            'addUser',
            new AjaxModal(
               $router->url($request, null, null, 'addUser', null, null),
               __('grid.user.add'),
               'modal_add_user',
               true
               ),
            __('grid.user.add'),
            'add_user')
      );
 
      //
      // Grid columns.
      //
      $cellProvider = new DataObjectGridCellProvider();
 
      // First Name.
      $this->addColumn(
         new GridColumn(
            'givenName',
            'user.givenName',
            null,
            null,
            $cellProvider
         )
      );
 
      // Last Name.
      $this->addColumn(
         new GridColumn(
            'familyName',
            'user.familyName',
            null,
            null,
            $cellProvider
         )
      );
 
      // User name.
      $this->addColumn(
         new GridColumn(
            'username',
            'user.username',
            null,
            null,
            $cellProvider
         )
      );
 
      // Email.
      $this->addColumn(
         new GridColumn(
            'email',
            'user.email',
            null,
            null,
            $cellProvider
         )
      );
   }
 
 
   //
   // Implement methods from GridHandler.
   //
   protected function getRowInstance() {
      return new UserGridRow($this->_oldUserId);
   }
 
   function initFeatures($request, $args) {
      import('lib.pkp.classes.controllers.grid.feature.PagingFeature');
      return array(new PagingFeature());
   }
 
   protected function loadData($request, $filter) {
      // Get the context.
      $context = $request->getContext();
 
      // Get all users for this context that match search criteria.
      $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); /* @var $userGroupDao UserGroupDAO */
      $rangeInfo = $this->getGridRangeInfo($request, $this->getId());
 
      return $userGroupDao->getUsersById(
         $filter['userGroup'],
         $filter['includeNoRole']?null:$context->getId(),
         $filter['searchField'],
         $filter['search']?$filter['search']:null,
         $filter['searchMatch'],
         $rangeInfo
      );
   }
 
   function renderFilter($request, $filterData = array()) {
      $context = $request->getContext();
      $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); /* @var $userGroupDao UserGroupDAO */
      $userGroups = $userGroupDao->getByContextId($context->getId());
      $userGroupOptions = array('' => __('grid.user.allRoles'));
      while ($userGroup = $userGroups->next()) {
         $userGroupOptions[$userGroup->getId()] = $userGroup->getLocalizedName();
      }
 
      // Import UserDAO to define the USER_FIELD_* constants.
      import('lib.pkp.classes.user.UserDAO');
      $fieldOptions = array(
         IDENTITY_SETTING_GIVENNAME => 'user.givenName',
         IDENTITY_SETTING_FAMILYNAME => 'user.familyName',
         USER_FIELD_USERNAME => 'user.username',
         USER_FIELD_EMAIL => 'user.email'
      );
 
      $matchOptions = array(
         'contains' => 'form.contains',
         'is' => 'form.is'
      );
 
      $filterData = array(
         'userGroupOptions' => $userGroupOptions,
         'fieldOptions' => $fieldOptions,
         'matchOptions' => $matchOptions,
         // oldUserId is used when merging users. see: userGridFilter.tpl
         'oldUserId' => $request->getUserVar('oldUserId'),
      );
 
      return parent::renderFilter($request, $filterData);
   }
 
   function getFilterSelectionData($request) {
      // Get the search terms.
      $includeNoRole = $request->getUserVar('includeNoRole') ? (int) $request->getUserVar('includeNoRole') : null;
      $userGroup = $request->getUserVar('userGroup') ? (int)$request->getUserVar('userGroup') : null;
      $searchField = $request->getUserVar('searchField');
      $searchMatch = $request->getUserVar('searchMatch');
      $search = $request->getUserVar('search');
 
      return $filterSelectionData = array(
         'includeNoRole' => $includeNoRole,
         'userGroup' => $userGroup,
         'searchField' => $searchField,
         'searchMatch' => $searchMatch,
         'search' => $search ? $search : ''
      );
   }
 
   protected function getFilterForm() {
      return 'controllers/grid/settings/user/userGridFilter.tpl';
   }
 
   public function getJSHandler() {
      return '$.pkp.controllers.grid.users.UserGridHandler';
   }
 
 
   //
   // Public grid actions.
   //
   function addUser($args, $request) {
      // Calling editUser with an empty row id will add a new user.
      return $this->editUser($args, $request);
   }
 
   function editUser($args, $request) {
      // Identify the user Id.
      $userId = $request->getUserVar('rowId');
      if (!$userId) $userId = $request->getUserVar('userId');
 
      $user = $request->getUser();
      if ($userId !== null && !Validation::canAdminister($userId, $user->getId())) {
         // We don't have administrative rights over this user.
         return new JSONMessage(false, __('grid.user.cannotAdminister'));
      } else {
         // Form handling.
         $userForm = new UserDetailsForm($request, $userId);
         $userForm->initData();
 
         return new JSONMessage(true, $userForm->display($request));
      }
   }
 
   function updateUser($args, $request) {
      $user = $request->getUser();
 
      // Identify the user Id.
      $userId = $request->getUserVar('userId');
 
      if ($userId !== null && !Validation::canAdminister($userId, $user->getId())) {
         // We don't have administrative rights over this user.
         return new JSONMessage(false, __('grid.user.cannotAdminister'));
      }
 
      // Form handling.
      $userForm = new UserDetailsForm($request, $userId);
      $userForm->readInputData();
 
      if ($userForm->validate()) {
         $user = $userForm->execute();
 
         // If this is a newly created user, show role management form.
         if (!$userId) {
            import('lib.pkp.controllers.grid.settings.user.form.UserRoleForm');
            $userRoleForm = new UserRoleForm($user->getId(), $user->getFullName());
            $userRoleForm->initData();
            return new JSONMessage(true, $userRoleForm->display($request));
         } else {
 
            // Successful edit of an existing user.
            $notificationManager = new NotificationManager();
            $user = $request->getUser();
            $notificationManager->createTrivialNotification($user->getId(), NOTIFICATION_TYPE_SUCCESS, array('contents' => __('notification.editedUser')));
 
            // Prepare the grid row data.
            return DAO::getDataChangedEvent($userId);
         }
      } else {
         return new JSONMessage(false);
      }
   }
 
   function updateUserRoles($args, $request) {
      $user = $request->getUser();
 
      // Identify the user Id.
      $userId = $request->getUserVar('userId');
 
      if ($userId !== null && !Validation::canAdminister($userId, $user->getId())) {
         // We don't have administrative rights over this user.
         return new JSONMessage(false, __('grid.user.cannotAdminister'));
      }
 
      // Form handling.
      import('lib.pkp.controllers.grid.settings.user.form.UserRoleForm');
      $userRoleForm = new UserRoleForm($userId, $user->getFullName());
      $userRoleForm->readInputData();
 
      if ($userRoleForm->validate()) {
         $userRoleForm->execute();
 
         // Successfully managed newly created user's roles.
         return DAO::getDataChangedEvent();
      } else {
         return new JSONMessage(false);
      }
   }
 
   function editDisableUser($args, $request) {
      $user = $request->getUser();
 
      // Identify the user Id.
      $userId = $request->getUserVar('rowId');
      if (!$userId) $userId = $request->getUserVar('userId');
 
      // Are we enabling or disabling this user.
      $enable = isset($args['enable']) ? (bool) $args['enable'] : false;
 
      if ($userId !== null && !Validation::canAdminister($userId, $user->getId())) {
         // We don't have administrative rights over this user.
         return new JSONMessage(false, __('grid.user.cannotAdminister'));
      } else {
         // Form handling
         import('lib.pkp.controllers.grid.settings.user.form.UserDisableForm');
         $userForm = new UserDisableForm($userId, $enable);
 
         $userForm->initData();
 
         return new JSONMessage(true, $userForm->display($request));
      }
   }
 
   function disableUser($args, $request) {
      $user = $request->getUser();
 
      // Identify the user Id.
      $userId = $request->getUserVar('userId');
 
      // Are we enabling or disabling this user.
      $enable = (bool) $request->getUserVar('enable');
 
      if ($userId !== null && !Validation::canAdminister($userId, $user->getId())) {
         // We don't have administrative rights over this user.
         return new JSONMessage(false, __('grid.user.cannotAdminister'));
      }
 
      // Form handling.
      import('lib.pkp.controllers.grid.settings.user.form.UserDisableForm');
      $userForm = new UserDisableForm($userId, $enable);
 
      $userForm->readInputData();
 
      if ($userForm->validate()) {
         $user = $userForm->execute();
 
         // Successful enable/disable of an existing user.
         // Update grid data.
         return DAO::getDataChangedEvent($userId);
 
      } else {
         return new JSONMessage(false, $userForm->display($request));
      }
   }
 
   function removeUser($args, $request) {
      if (!$request->checkCSRF()) return new JSONMessage(false);
 
      $context = $request->getContext();
      $user = $request->getUser();
 
      // Identify the user Id.
      $userId = $request->getUserVar('rowId');
 
      if ($userId !== null && !Validation::canAdminister($userId, $user->getId())) {
         // We don't have administrative rights over this user.
         return new JSONMessage(false, __('grid.user.cannotAdminister'));
      }
 
      // Remove user from all user group assignments for this context.
      $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); /* @var $userGroupDao UserGroupDAO */
 
      // Check if this user has any user group assignments for this context.
      if (!$userGroupDao->userInAnyGroup($userId, $context->getId())) {
         return new JSONMessage(false, __('grid.user.userNoRoles'));
      } else {
         $userGroupDao->deleteAssignmentsByContextId($context->getId(), $userId);
         return DAO::getDataChangedEvent($userId);
      }
   }
 
   function editEmail($args, $request) {
      $user = $request->getUser();
      $context = $request->getContext();
 
      // Identify the user Id.
      $userId = $request->getUserVar('rowId');
 
      $roleDao = DAORegistry::getDAO('RoleDAO'); /* @var $roleDao RoleDAO */
      if (
         !$roleDao->userHasRole(CONTEXT_SITE, $user->getId(), ROLE_ID_SITE_ADMIN) && !(
            $context &&
            $roleDao->userHasRole($context->getId(), $user->getId(), ROLE_ID_MANAGER)
         )
      ) {
         // We don't have administrative rights over this user.
         return new JSONMessage(false, __('grid.user.cannotAdminister'));
      } else {
         // Form handling.
         import('lib.pkp.controllers.grid.settings.user.form.UserEmailForm');
         $userEmailForm = new UserEmailForm($userId);
         $userEmailForm->initData();
 
         return new JSONMessage(true, $userEmailForm->fetch($request));
      }
   }
 
   function sendEmail($args, $request) {
      $user = $request->getUser();
      $context = $request->getContext();
 
      // Identify the user Id.
      $userId = $request->getUserVar('userId');
 
      $roleDao = DAORegistry::getDAO('RoleDAO'); /* @var $roleDao RoleDAO */
      if (
         !$roleDao->userHasRole(CONTEXT_SITE, $user->getId(), ROLE_ID_SITE_ADMIN) && !(
            $context &&
            $roleDao->userHasRole($context->getId(), $user->getId(), ROLE_ID_MANAGER)
         )
      ) {
         // We don't have administrative rights over this user.
         return new JSONMessage(false, __('grid.user.cannotAdminister'));
      }
      // Form handling.
      import('lib.pkp.controllers.grid.settings.user.form.UserEmailForm');
      $userEmailForm = new UserEmailForm($userId);
      $userEmailForm->readInputData();
 
      if ($userEmailForm->validate()) {
         $userEmailForm->execute();
         return new JSONMessage(true);
      } else {
         return new JSONMessage(false, __('validator.filled'));
      }
   }
 
   function mergeUsers($args, $request) {
 
      $newUserId =  (int) $request->getUserVar('newUserId');
      $oldUserId = (int) $request->getUserVar('oldUserId');
      $user = $request->getUser();
 
      // if there is a $newUserId, this is the second time through, so merge the users.
      if ($newUserId > 0 && $oldUserId > 0 && Validation::canAdminister($oldUserId, $user->getId())) {
         if (!$request->checkCSRF()) return new JSONMessage(false);
         import('classes.user.UserAction');
         $userAction = new UserAction();
         $userAction->mergeUsers($oldUserId, $newUserId);
         $json = new JSONMessage(true);
         $json->setGlobalEvent('userMerged', array(
            'oldUserId' => $oldUserId,
            'newUserId' => $newUserId,
         ));
         return $json;
 
      // Otherwise present the grid for selecting the user to merge into
      } else {
         $userGrid = new UserGridHandler();
         $userGrid->initialize($request);
         $userGrid->setTitle('grid.user.mergeUsers.mergeIntoUser');
         return $userGrid->fetchGrid($args, $request);
      }
   }
 
   function getRequestArgs() {
      $requestArgs = (array) parent::getRequestArgs();
      $requestArgs['oldUserId'] = $this->_oldUserId;
      return $requestArgs;
   }
}