classes/security/RoleDAO.inc.php

<?php

import('classes.security.Role');
import('lib.pkp.classes.security.UserGroupAssignment');

class RoleDAO extends DAO {
   var $userDao;

   function RoleDAO() {
      parent::DAO();
      $this->userDao =& DAORegistry::getDAO('UserDAO');
   }

   function &getUsersByRoleId($roleId = null, $pressId = null, $searchType = null, $search = null, $searchMatch = null, $dbResultRange = null) {
      $users = array();

      $paramArray = array(ASSOC_TYPE_USER, 'interest');
      if (isset($roleId)) $paramArray[] = (int) $roleId;
      if (isset($pressId)) $paramArray[] = (int) $pressId;
      // For security / resource usage reasons, a role or press ID
      // must be specified. Don't allow calls supplying neither.
      if ($pressId === null && $roleId === null) return null;

      $searchSql = '';

      $searchTypeMap = array(
         USER_FIELD_FIRSTNAME => 'u.first_name',
         USER_FIELD_LASTNAME => 'u.last_name',
         USER_FIELD_USERNAME => 'u.username',
         USER_FIELD_EMAIL => 'u.email',
         USER_FIELD_INTERESTS => 'cves.setting_value'
      );

      if (!empty($search) && isset($searchTypeMap[$searchType])) {
         $fieldName = $searchTypeMap[$searchType];
         switch ($searchMatch) {
            case 'is':
               $searchSql = "AND LOWER($fieldName) = LOWER(?)";
               $paramArray[] = $search;
               break;
            case 'contains':
               $searchSql = "AND LOWER($fieldName) LIKE LOWER(?)";
               $paramArray[] = '%' . $search . '%';
               break;
            case 'startsWith':
               $searchSql = "AND LOWER($fieldName) LIKE LOWER(?)";
               $paramArray[] = $search . '%';
               break;
         }
      } elseif (!empty($search)) switch ($searchType) {
         case USER_FIELD_USERID:
            $searchSql = 'AND u.user_id=?';
            $paramArray[] = $search;
            break;
         case USER_FIELD_INITIAL:
            $searchSql = 'AND LOWER(u.last_name) LIKE LOWER(?)';
            $paramArray[] = $search . '%';
            break;
      }

      $searchSql .= ' ORDER BY u.last_name, u.first_name'; // FIXME Add "sort field" parameter?

      $result =& $this->retrieveRange(
         'SELECT DISTINCT u.* FROM users AS u LEFT JOIN controlled_vocabs cv ON (cv.assoc_type = ? AND cv.assoc_id = u.user_id AND cv.symbolic = ?)
         LEFT JOIN controlled_vocab_entries cve ON (cve.controlled_vocab_id = cv.controlled_vocab_id)
         LEFT JOIN controlled_vocab_entry_settings cves ON (cves.controlled_vocab_entry_id = cve.controlled_vocab_entry_id),
         user_groups AS ug, user_user_groups AS uug
         WHERE ug.user_group_id = uug.user_group_id AND u.user_id = uug.user_id' . (isset($roleId) ? ' AND ug.role_id = ?' : '') . (isset($pressId) ? ' AND ug.context_id = ?' : '') . ' ' . $searchSql,
         $paramArray,
         $dbResultRange
      );

      $returner = new DAOResultFactory($result, $this->userDao, '_returnUserFromRowWithData');
      return $returner;
   }

   function userHasRole($pressId, $userId, $roleId) {
      $result =& $this->retrieve(
         'SELECT count(*) FROM user_groups ug JOIN user_user_groups uug ON ug.user_group_id = uug.user_group_id
         WHERE ug.context_id = ? AND uug.user_id = ? AND ug.role_id = ?',
         array((int) $pressId, (int) $userId, (int) $roleId)
      );

      // > 0 because user could belong to more than one user group with this role
      $returner = isset($result->fields[0]) && $result->fields[0] > 0 ? true : false;

      $result->Close();
      unset($result);

      return $returner;
   }

   function getByUserId($userId, $pressId = null) {
      $params = array((int) $userId);
      if ($pressId) $params[] = (int) $pressId;
      $result =& $this->retrieve(
         'SELECT  DISTINCT ug.role_id
         FROM  user_groups ug
            JOIN user_user_groups uug ON ug.user_group_id = uug.user_group_id
         WHERE uug.user_id = ?' . ($pressId?' AND ug.context_id = ?':''),
         $params
      );

      $roles = array();
      while ( !$result->EOF ) {
         $roles[] = new Role($result->fields[0]);
         $result->MoveNext();
      }
      $result->Close();
      unset($result);

      return $roles;
   }

   function getByUserIdGroupedByContext($userId) {
      $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');
      $userGroupsFactory =& $userGroupDao->getByUserId($userId);

      $roles = array();
      while ($userGroup =& $userGroupsFactory->next()) {
         $roles[$userGroup->getContextId()][$userGroup->getRoleId()] = new Role($userGroup->getRoleId());
      }

      return $roles;
   }

   function getPressUsersRoleCount($pressId, $roleId) {
      $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');
      return $userGroupDao->getContextUsersCount($pressId, null, $roleId);
   }

   function getRoleIdFromPath($rolePath) {
      switch ($rolePath) {
         case 'admin':
            return ROLE_ID_SITE_ADMIN;
         case 'manager':
            return ROLE_ID_PRESS_MANAGER;
         case 'author':
            return ROLE_ID_AUTHOR;
         case 'seriesEditor':
            return ROLE_ID_SERIES_EDITOR;
         case 'reviewer':
            return ROLE_ID_REVIEWER;
         case 'reader':
            return ROLE_ID_READER;
         default:
            return null;
      }
   }

   function getSortMapping($heading) {
      switch ($heading) {
         case 'username': return 'u.username';
         case 'name': return 'u.last_name';
         case 'email': return 'u.email';
         default: return null;
      }
   }

   function getRoleNames($pressOnly = false, $roleIds = null) {
      $siteRoleNames = array(ROLE_ID_SITE_ADMIN => 'user.role.siteAdmin');
      $pressRoleNames = array(
         ROLE_ID_PRESS_MANAGER => 'user.role.manager',
         ROLE_ID_SERIES_EDITOR => 'user.role.seriesEditor',
         ROLE_ID_PRESS_ASSISTANT => 'user.role.pressAssistant',
         ROLE_ID_AUTHOR => 'user.role.author',
         ROLE_ID_REVIEWER => 'user.role.reviewer'
      );
      $roleNames = $pressOnly ? $pressRoleNames : $siteRoleNames + $pressRoleNames;

      if(!empty($roleIds)) {
         $returner = array();
         foreach($roleIds as $roleId) {
            if(isset($roleNames[$roleId])) $returner[$roleId] = $roleNames[$roleId];
         }
         return $returner;
      } else {
         return $roleNames;
      }
   }
}

?>