controllers/grid/settings/user/UserGridHandler.inc.php

<?php

import('lib.pkp.classes.controllers.grid.GridHandler');
import('lib.pkp.classes.controllers.grid.DataObjectGridCellProvider');

import('controllers.grid.settings.user.UserGridRow');
import('controllers.grid.settings.user.form.UserDetailsForm');

class UserGridHandler extends GridHandler {
   function UserGridHandler() {
      parent::GridHandler();
      $this->addRoleAssignment(array(
         ROLE_ID_PRESS_MANAGER),
         array('fetchGrid', 'fetchRow', 'editUser', 'updateUser', 'updateUserRoles',
            'editDisableUser', 'disableUser', 'removeUser', 'addUser',
            'editEmail', 'sendEmail', 'suggestUsername')
      );
   }


   //
   // Implement template methods from PKPHandler.
   //
   function authorize(&$request, $args, $roleAssignments) {
      import('classes.security.authorization.OmpPressAccessPolicy');
      $this->addPolicy(new OmpPressAccessPolicy($request, $roleAssignments));
      return parent::authorize($request, $args, $roleAssignments);
   }

   function initialize(&$request) {
      parent::initialize($request);

      // Load user-related translations.
      AppLocale::requireComponents(
         LOCALE_COMPONENT_PKP_USER,
         LOCALE_COMPONENT_OMP_MANAGER
      );

      // 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.
      //

      // First Name.
      $cellProvider = new DataObjectGridCellProvider();
      $this->addColumn(
         new GridColumn(
            'firstName',
            'user.firstName',
            null,
            'controllers/grid/gridCell.tpl',
            $cellProvider
         )
      );

      // Last Name.
      $cellProvider = new DataObjectGridCellProvider();
      $this->addColumn(
         new GridColumn(
            'lastName',
            'user.lastName',
            null,
            'controllers/grid/gridCell.tpl',
            $cellProvider
         )
      );

      // Email.
      $cellProvider = new DataObjectGridCellProvider();
      $this->addColumn(
         new GridColumn(
            'email',
            'user.email',
            null,
            'controllers/grid/gridCell.tpl',
            $cellProvider
         )
      );
   }


   //
   // Implement methods from GridHandler.
   //
   function &getRowInstance() {
      $row = new UserGridRow();
      return $row;
   }

   function loadData(&$request, $filter) {
      // Get the press.
      $press =& $request->getPress();
      $pressId = $press->getId();

      // Get all users for this press that match search criteria.
      $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');
      $rangeInfo = $this->getRangeInfo('users');
      $rowData = array();
      $pressIds = array();

      if ($filter['includeNoRole'] == null) {
         $pressIds[] = $pressId;
      } else {
         $pressDao =& DAORegistry::getDAO('PressDAO');
         $presses =& $pressDao->getPresses();
         while ($press =& $presses->next()) {
            $pressIds[] = $press->getId();
         }

         // Get users with no user group assignment.
         $usersWithNoUserGroup =& $userGroupDao->getUsersWithNoUserGroupAssignments($filter);
         if (!$usersWithNoUserGroup->wasEmpty()) {
            while ($userWithNoUserGroup =& $usersWithNoUserGroup->next()) {
               $rowData[$userWithNoUserGroup->getId()] = $userWithNoUserGroup;
            }
         }
      }

      foreach ($pressIds as $pressId) {
         $users =& $userGroupDao->getUsersById(
         $filter['userGroup'],
         $pressId,
         $filter['searchField'],
         $filter['search'],
         $filter['searchMatch'],
         $rangeInfo
         );

         while ($user =& $users->next()) {
            $rowData[$user->getId()] = $user;
         }
      }

      return $rowData;
   }

   function renderFilter(&$request) {
      $press =& $request->getPress();
      $pressId = $press->getId();
      $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');
      $userGroups =& $userGroupDao->getByContextId($press->getId());
      $userGroupOptions = array('' => __('grid.user.allRoles'));
      while (!$userGroups->eof()) {
         $userGroup =& $userGroups->next();
         $userGroupOptions[$userGroup->getId()] = $userGroup->getLocalizedName();
      }

      // Import PKPUserDAO to define the USER_FIELD_* constants.
      import('lib.pkp.classes.user.PKPUserDAO');
      $fieldOptions = array(
         USER_FIELD_FIRSTNAME => 'user.firstName',
         USER_FIELD_LASTNAME => 'user.lastName',
         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
      );

      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
      );
   }

   function getFilterForm() {
      return 'controllers/grid/settings/user/userGridFilter.tpl';
   }


   //
   // Public grid actions.
   //
   function suggestUsername($args, &$request) {
      $suggestion = Validation::suggestUsername(
         $request->getUserVar('firstName'),
         $request->getUserVar('lastName')
      );

      $json = new JSONMessage(true, $suggestion);
      return $json->getString();
   }

   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.
         $json = new JSONMessage(false, __('grid.user.cannotAdminister'));
      } else {
         // Form handling.
         $userForm = new UserDetailsForm($request, $userId);
         $userForm->initData($args, $request);

         $json = new JSONMessage(true, $userForm->display($args, $request));
      }
      return $json->getString();
   }

   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.
         $json = new JSONMessage(false, __('grid.user.cannotAdminister'));
      } else {
         // Form handling.
         $userForm = new UserDetailsForm($request, $userId);
         $userForm->readInputData();

         if ($userForm->validate()) {
            $user =& $userForm->execute($args, $request);

            // If this is a newly created user, show role management form.
            if (!$userId) {
               import('controllers.grid.settings.user.form.UserRoleForm');
               $userRoleForm = new UserRoleForm($user->getId(), $user->getFullName());
               $userRoleForm->initData($args, $request);
               $json = new JSONMessage(true, $userRoleForm->display($args, $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 {
            $json = new JSONMessage(false);
         }
      }
      return $json->getString();
   }

   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.
         $json = new JSONMessage(false, __('grid.user.cannotAdminister'));
      } else {
         // Form handling.
         import('controllers.grid.settings.user.form.UserRoleForm');
         $userRoleForm = new UserRoleForm($userId, $user->getFullName());
         $userRoleForm->readInputData();

         if ($userRoleForm->validate()) {
            $userRoleForm->execute($args, $request);

            // Successfully managed newly created user's roles.
            return DAO::getDataChangedEvent($userId);
         } else {
            $json = new JSONMessage(false);
         }
      }
      return $json->getString();
   }

   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.
         $json = new JSONMessage(false, __('grid.user.cannotAdminister'));
      } else {
         // Form handling
         import('controllers.grid.settings.user.form.UserDisableForm');
         $userForm = new UserDisableForm($userId, $enable);

         $userForm->initData($args, $request);

         $json = new JSONMessage(true, $userForm->display($args, $request));
      }
      return $json->getString();
   }

   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.
         $json = new JSONMessage(false, __('grid.user.cannotAdminister'));
      } else {
         // Form handling.
         import('controllers.grid.settings.user.form.UserDisableForm');
         $userForm = new UserDisableForm($userId, $enable);

         $userForm->readInputData();

         if ($userForm->validate()) {
            $user =& $userForm->execute($args, $request);

            // Successful enable/disable of an existing user.
            // Update grid data.
            return DAO::getDataChangedEvent($userId);

         } else {
            $json = new JSONMessage(false, $userForm->display($args, $request));
         }
      }
      return $json->getString();
   }

   function removeUser($args, &$request) {
      $press =& $request->getPress();
      $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.
         $json = new JSONMessage(false, __('grid.user.cannotAdminister'));
      } else {
         // Remove user from all user group assignments for this press.
         $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');

         // Check if this user has any user group assignments for this press.
         if (!$userGroupDao->userInAnyGroup($userId, $press->getId())) {
            $json = new JSONMessage(false, __('grid.user.userNoRoles'));
         } else {
            $userGroupDao->deleteAssignmentsByContextId($press->getId(), $userId);
            return DAO::getDataChangedEvent($userId);
         }
      }
      return $json->getString();
   }

   function editEmail($args, &$request) {
      $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.
         $json = new JSONMessage(false, __('grid.user.cannotAdminister'));
      } else {
         // Form handling.
         import('controllers.grid.settings.user.form.UserEmailForm');
         $userEmailForm = new UserEmailForm($userId);
         $userEmailForm->initData($args, $request);

         $json = new JSONMessage(true, $userEmailForm->display($args, $request));
      }
      return $json->getString();
   }

   function sendEmail($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.
         $json = new JSONMessage(false, __('grid.user.cannotAdminister'));
      } else {
         // Form handling.
         import('controllers.grid.settings.user.form.UserEmailForm');
         $userEmailForm = new UserEmailForm($userId);
         $userEmailForm->readInputData();

         if ($userEmailForm->validate()) {
            $userEmailForm->execute($args, $request);
            $json = new JSONMessage(true);
         } else {
            $json = new JSONMessage(false, $userEmailForm->display($args, $request));
         }
      }
      return $json->getString();
   }
}

?>