UserGroupDAO.inc.php

<?php
 
import('lib.pkp.classes.security.UserGroup');
import('lib.pkp.classes.workflow.WorkflowStageDAO');
 
class UserGroupDAO extends DAO {
   var $userDao;
 
   var $userGroupAssignmentDao;
 
   function __construct() {
      parent::__construct();
      $this->userDao = DAORegistry::getDAO('UserDAO');
      $this->userGroupAssignmentDao = DAORegistry::getDAO('UserGroupAssignmentDAO');
   }
 
   function newDataObject() {
      return new UserGroup();
   }
 
   function _returnFromRow($row) {
      $userGroup = $this->newDataObject();
      $userGroup->setId($row['user_group_id']);
      $userGroup->setRoleId($row['role_id']);
      $userGroup->setContextId($row['context_id']);
      $userGroup->setDefault($row['is_default']);
      $userGroup->setShowTitle($row['show_title']);
      $userGroup->setPermitSelfRegistration($row['permit_self_registration']);
      $userGroup->setPermitMetadataEdit($row['permit_metadata_edit']);
 
      $this->getDataObjectSettings('user_group_settings', 'user_group_id', $row['user_group_id'], $userGroup);
 
      HookRegistry::call('UserGroupDAO::_returnFromRow', array(&$userGroup, &$row));
 
      return $userGroup;
   }
 
   function insertObject($userGroup) {
      $this->update(
         'INSERT INTO user_groups
            (role_id, context_id, is_default, show_title, permit_self_registration, permit_metadata_edit)
            VALUES
            (?, ?, ?, ?, ?, ?)',
         array(
            (int) $userGroup->getRoleId(),
            (int) $userGroup->getContextId(),
            $userGroup->getDefault()?1:0,
            $userGroup->getShowTitle()?1:0,
            $userGroup->getPermitSelfRegistration()?1:0,
            $userGroup->getPermitMetadataEdit()?1:0,
         )
      );
 
      $userGroup->setId($this->getInsertId());
      $this->updateLocaleFields($userGroup);
      return $userGroup->getId();
   }
 
   function updateObject($userGroup) {
      $this->update(
         'UPDATE user_groups SET
            role_id = ?,
            context_id = ?,
            is_default = ?,
            show_title = ?,
            permit_self_registration = ?,
            permit_metadata_edit = ?
         WHERE user_group_id = ?',
         array(
            (int) $userGroup->getRoleId(),
            (int) $userGroup->getContextId(),
            $userGroup->getDefault()?1:0,
            $userGroup->getShowTitle()?1:0,
            $userGroup->getPermitSelfRegistration()?1:0,
            $userGroup->getPermitMetadataEdit()?1:0,
            (int) $userGroup->getId(),
         )
      );
 
      $this->updateLocaleFields($userGroup);
   }
 
   function deleteById($contextId, $userGroupId) {
      $this->userGroupAssignmentDao->deleteAssignmentsByUserGroupId($userGroupId);
      $this->update('DELETE FROM user_group_settings WHERE user_group_id = ?', (int) $userGroupId);
      $this->update('DELETE FROM user_groups WHERE user_group_id = ?', (int) $userGroupId);
      $this->removeAllStagesFromGroup($contextId, $userGroupId);
   }
 
   function deleteObject($userGroup) {
      $this->deleteById($userGroup->getContextId(), $userGroup->getId());
   }
 
 
   function deleteByContextId($contextId) {
      $result = $this->retrieve('SELECT user_group_id FROM user_groups WHERE context_id = ?', (int) $contextId);
 
      for ($i=1; !$result->EOF; $i++) {
         list($userGroupId) = $result->fields;
 
         $this->update('DELETE FROM user_group_stage WHERE user_group_id = ?', (int) $userGroupId);
         $this->update('DELETE FROM user_group_settings WHERE user_group_id = ?', (int) $userGroupId);
         $this->update('DELETE FROM user_groups WHERE user_group_id = ?', (int) $userGroupId);
 
         $result->MoveNext();
      }
   }
 
   function getInsertId() {
      return $this->_getInsertId('user_groups', 'user_group_id');
   }
 
   function getLocaleFieldNames() {
      return array('name', 'abbrev');
   }
 
   function getAdditionalFieldNames() {
      return array_merge(parent::getAdditionalFieldNames(), array(
         'recommendOnly',
 
      ));
   }
 
   function updateLocaleFields($userGroup) {
      $this->updateDataObjectSettings('user_group_settings', $userGroup, array(
         'user_group_id' => (int) $userGroup->getId()
      ));
   }
 
   function getById($userGroupId, $contextId = null) {
      $params = array((int) $userGroupId);
      if ($contextId !== null) $params[] = (int) $contextId;
      $result = $this->retrieve(
         'SELECT  *
         FROM  user_groups
         WHERE user_group_id = ?' . ($contextId !== null?' AND context_id = ?':''),
         $params
      );
 
      return $this->_returnFromRow($result->GetRowAssoc(false));
   }
 
   function getDefaultByRoleId($contextId, $roleId) {
      $allDefaults = $this->getByRoleId($contextId, $roleId, true);
      if ($allDefaults->eof()) return false;
      return $allDefaults->next();
   }
 
   function isDefault($userGroupId) {
      $result = $this->retrieve(
         'SELECT is_default FROM user_groups
         WHERE user_group_id = ?',
         (int) $userGroupId
      );
 
      $result = $result->GetArray();
      if (isset($result[0]['is_default'])) {
         return $result[0]['is_default'];
      } else {
         return false;
      }
   }
 
   function getByRoleId($contextId, $roleId, $default = false, $dbResultRange = null) {
      $params = array((int) $contextId, (int) $roleId);
      if ($default) $params[] = 1; // true
      $result = $this->retrieveRange(
         'SELECT  *
         FROM  user_groups
         WHERE context_id = ? AND
            role_id = ?
            ' . ($default?' AND is_default = ?':'')
         . ' ORDER BY user_group_id',
         $params,
         $dbResultRange
      );
 
      return new DAOResultFactory($result, $this, '_returnFromRow');
   }
 
   function getUserGroupIdsByRoleId($roleId, $contextId = null) {
      $params = array((int) $roleId);
      if ($contextId) $params[] = (int) $contextId;
 
      $result = $this->retrieve(
         'SELECT  user_group_id
         FROM  user_groups
            WHERE role_id = ?
            ' . ($contextId?' AND context_id = ?':''),
         $params
      );
 
      $userGroupIds = array();
      while (!$result->EOF) {
         $userGroupIds[] = (int) $result->fields[0];
         $result->MoveNext();
      }
 
      $result->Close();
      return $userGroupIds;
   }
 
   function userInGroup($userId, $userGroupId) {
      $result = $this->retrieve(
         'SELECT  count(*)
         FROM  user_groups ug
            JOIN user_user_groups uug ON ug.user_group_id = uug.user_group_id
         WHERE
            uug.user_id = ? AND
            ug.user_group_id = ?',
         array((int) $userId, (int) $userGroupId)
      );
 
      // > 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();
      return $returner;
   }
 
   function userInAnyGroup($userId, $contextId = null) {
      $params = array((int) $userId);
      if ($contextId) $params[] = (int) $contextId;
 
      $result = $this->retrieve(
         'SELECT  count(*)
         FROM  user_groups ug
            JOIN user_user_groups uug ON ug.user_group_id = uug.user_group_id
         WHERE uug.user_id = ?
            ' . ($contextId?' AND ug.context_id = ?':''),
         $params
      );
 
      $returner = isset($result->fields[0]) && $result->fields[0] > 0 ? true : false;
 
      $result->Close();
      return $returner;
   }
 
   function getByUserId($userId, $contextId = null){
      $params = array((int) $userId);
      if ($contextId) $params[] = (int) $contextId;
 
      $result = $this->retrieve(
         'SELECT  ug.*
         FROM  user_groups ug
            JOIN user_user_groups uug ON ug.user_group_id = uug.user_group_id
            WHERE uug.user_id = ?
            ' . ($contextId?' AND ug.context_id = ?':''),
         $params
      );
 
      return new DAOResultFactory($result, $this, '_returnFromRow');
   }
 
   function contextHasGroup($contextId, $userGroupId) {
      $result = $this->retrieve(
         'SELECT count(*)
            FROM user_groups ug
            WHERE ug.user_group_id = ?
            AND ug.context_id = ?',
         array (
            (int) $userGroupId,
            (int) $contextId
         )
      );
 
      $returner = isset($result->fields[0]) && $result->fields[0] == 0 ? false : true;
 
      $result->Close();
      return $returner;
   }
 
   function getByContextId($contextId = null, $dbResultRange = null) {
      $params = array();
      if ($contextId) $params[] = (int) $contextId;
 
      $result = $this->retrieveRange(
         'SELECT ug.*
         FROM  user_groups ug' .
            ($contextId?' WHERE ug.context_id = ?':''),
         $params,
         $dbResultRange
      );
 
      return new DAOResultFactory($result, $this, '_returnFromRow');
   }
 
   function getContextUsersCount($contextId, $userGroupId = null, $roleId = null) {
      $params = array((int) $contextId);
      if ($userGroupId) $params[] = (int) $userGroupId;
      if ($roleId) $params[] = (int) $roleId;
      $result = $this->retrieve(
         'SELECT  COUNT(DISTINCT(uug.user_id))
         FROM  user_groups ug
            JOIN user_user_groups uug ON ug.user_group_id = uug.user_group_id
         WHERE context_id = ?' .
            ($userGroupId?' AND ug.user_group_id = ?':'') .
            ($roleId?' AND ug.role_id = ?':''),
         $params
      );
 
      $returner = $result->fields[0];
 
      $result->Close();
      return (int) $returner;
   }
 
   function getUsersByContextId($contextId, $searchType = null, $search = null, $searchMatch = null, $dbResultRange = null) {
      return $this->getUsersById(null, $contextId, $searchType, $search, $searchMatch, $dbResultRange);
   }
 
   function getUsersNotInRole($roleId, $contextId = null, $search = null, $rangeInfo = null) {
      $params = isset($search) ? array(IDENTITY_SETTING_GIVENNAME, IDENTITY_SETTING_FAMILYNAME) : array();
      $params[] = (int) $roleId;
      if ($contextId) $params[] = (int) $contextId;
      if(isset($search)) $params = array_merge($params, array_pad(array(), 4, '%' . $search . '%'));
 
      $result = $this->retrieveRange(
         'SELECT  DISTINCT u.*
         FROM  users u
         ' .(isset($search) ? '
               LEFT JOIN user_settings usgs ON (usgs.user_id = u.user_id AND usgs.setting_name = ?)
               LEFT JOIN user_settings usfs ON (usfs.user_id = u.user_id AND usfs.setting_name = ?)
            ':'') .'
         WHERE u.user_id NOT IN (
            SELECT   DISTINCT u.user_id
            FROM  users u, user_user_groups uug, user_groups ug
            WHERE u.user_id = uug.user_id
               AND ug.user_group_id = uug.user_group_id
               AND ug.role_id = ?' .
            ($contextId ? ' AND ug.context_id = ?' : '') .
            ')' .
         (isset($search) ? ' AND (usgs.setting_value LIKE ? OR usfs.setting_value LIKE ? OR u.email LIKE ? OR u.username LIKE ?)' : ''),
         $params,
         $rangeInfo
      );
      return new DAOResultFactory($result, $this->userDao, '_returnUserFromRowWithData');
   }
 
   function getUsersById($userGroupId = null, $contextId = null, $searchType = null, $search = null, $searchMatch = null, $dbResultRange = null) {
      $params = $this->userDao->getFetchParameters();
      $params = array_merge($params, array(IDENTITY_SETTING_GIVENNAME, IDENTITY_SETTING_FAMILYNAME));
      if ($contextId) $params[] = (int) $contextId;
      if ($userGroupId) $params[] = (int) $userGroupId;
 
      $sql =
         'SELECT DISTINCT u.*,
            ' . $this->userDao->getFetchColumns() .'
         FROM  users AS u
            LEFT JOIN user_settings us ON (us.user_id = u.user_id AND us.setting_name = \'affiliation\')
            LEFT JOIN user_interests ui ON (u.user_id = ui.user_id)
            LEFT JOIN controlled_vocab_entry_settings cves ON (ui.controlled_vocab_entry_id = cves.controlled_vocab_entry_id)
            LEFT JOIN user_user_groups uug ON (uug.user_id = u.user_id)
            LEFT JOIN user_groups ug ON (ug.user_group_id = uug.user_group_id)
            ' . $this->userDao->getFetchJoins() .'
            LEFT JOIN user_settings usgs ON (usgs.user_id = u.user_id AND usgs.setting_name = ?)
            LEFT JOIN user_settings usfs ON (usfs.user_id = u.user_id AND usfs.setting_name = ?)
 
         WHERE 1=1 ' .
            ($contextId?'AND ug.context_id = ? ':'') .
            ($userGroupId?'AND ug.user_group_id = ? ':'') .
            $this->_getSearchSql($searchType, $search, $searchMatch, $params);
 
      $result = $this->retrieveRange(
         $sql,
         $params,
         $dbResultRange
      );
 
      return new DAOResultFactory($result, $this->userDao, '_returnUserFromRowWithData');
   }
 
   //
   // UserGroupAssignment related
   //
   function deleteAssignmentsByUserId($userId, $userGroupId = null) {
      $this->userGroupAssignmentDao->deleteByUserId($userId, $userGroupId);
   }
 
   function deleteAssignmentsByUserGroupId($userGroupId) {
      $this->userGroupAssignmentDao->deleteAssignmentsByUserGroupId($userGroupId);
   }
 
   function deleteAssignmentsByContextId($contextId, $userId = null) {
      $this->userGroupAssignmentDao->deleteAssignmentsByContextId($contextId, $userId);
   }
 
   function assignUserToGroup($userId, $groupId) {
      $assignment = $this->userGroupAssignmentDao->newDataObject();
      $assignment->setUserId($userId);
      $assignment->setUserGroupId($groupId);
      $this->userGroupAssignmentDao->insertObject($assignment);
   }
 
   function removeUserFromGroup($userId, $groupId, $contextId) {
      $assignments = $this->userGroupAssignmentDao->getByUserId($userId, $contextId);
      while ($assignment = $assignments->next()) {
         if ($assignment->getUserGroupId() == $groupId) {
            $this->userGroupAssignmentDao->deleteAssignment($assignment);
         }
      }
   }
 
   function removeAllStagesFromGroup($contextId, $userGroupId) {
      $assignedStages = $this->getAssignedStagesByUserGroupId($contextId, $userGroupId);
      foreach($assignedStages as $stageId => $stageLocaleKey) {
         $this->removeGroupFromStage($contextId, $userGroupId, $stageId);
      }
   }
 
   function assignGroupToStage($contextId, $userGroupId, $stageId) {
      $this->update(
         'INSERT INTO user_group_stage (context_id, user_group_id, stage_id) VALUES (?, ?, ?)',
         array((int) $contextId, (int) $userGroupId, (int) $stageId)
      );
   }
 
   function removeGroupFromStage($contextId, $userGroupId, $stageId) {
      $this->update(
         'DELETE FROM user_group_stage WHERE context_id = ? AND user_group_id = ? AND stage_id = ?',
         array((int) $contextId, (int) $userGroupId, (int) $stageId)
      );
   }
 
   //
   // Extra settings (not handled by rest of Dao)
   //
   function updateSetting($userGroupId, $name, $value, $type = null, $isLocalized = false) {
      $keyFields = array('setting_name', 'locale', 'user_group_id');
 
      if (!$isLocalized) {
         $value = $this->convertToDB($value, $type);
         $this->replace('user_group_settings',
            array(
               'user_group_id' => (int) $userGroupId,
               'setting_name' => $name,
               'setting_value' => $value,
               'setting_type' => $type,
               'locale' => ''
            ),
            $keyFields
         );
      } else {
         if (is_array($value)) foreach ($value as $locale => $localeValue) {
            $this->update('DELETE FROM user_group_settings WHERE user_group_id = ? AND setting_name = ? AND locale = ?', array((int) $userGroupId, $name, $locale));
            if (empty($localeValue)) continue;
            $type = null;
            $this->update('INSERT INTO user_group_settings
               (user_group_id, setting_name, setting_value, setting_type, locale)
               VALUES (?, ?, ?, ?, ?)',
               array(
                  $userGroupId, $name, $this->convertToDB($localeValue, $type), $type, $locale
               )
            );
         }
      }
   }
 
 
   function getSetting($userGroupId, $name, $locale = null) {
      $params = array((int) $userGroupId, $name);
      if ($locale) $params[] = $locale;
      $result = $this->retrieve(
         'SELECT  setting_name, setting_value, setting_type, locale
         FROM  user_group_settings
         WHERE user_group_id = ? AND
            setting_name = ?' .
            ($locale?' AND locale = ?':''),
         $params
      );
 
      $recordCount = $result->RecordCount();
      $returner = false;
      if ($recordCount == 1) {
         $row = $result->getRowAssoc(false);
         $returner = $this->convertFromDB($row['setting_value'], $row['setting_type']);
      } elseif ($recordCount > 1) {
         $returner = array();
         while (!$result->EOF) {
            $returner[$row['locale']] = $this->convertFromDB($row['setting_value'], $row['setting_type']);
            $result->MoveNext();
         }
         $result->Close();
      }
      return $returner;
   }
 
   //
   // Install/Defaults with settings
   //
 
   function installSettings($contextId, $filename) {
      $xmlParser = new XMLParser();
      $tree = $xmlParser->parse($filename);
 
      $siteDao = DAORegistry::getDAO('SiteDAO'); /* @var $siteDao SiteDAO */
      $site = $siteDao->getSite();
      $installedLocales = $site->getInstalledLocales();
 
      if (!$tree) return false;
 
      foreach ($tree->getChildren() as $setting) {
         $roleId = hexdec($setting->getAttribute('roleId'));
         $nameKey = $setting->getAttribute('name');
         $abbrevKey = $setting->getAttribute('abbrev');
         $permitSelfRegistration = $setting->getAttribute('permitSelfRegistration');
         $permitMetadataEdit = $setting->getAttribute('permitMetadataEdit');
 
         // If has manager role then permitMetadataEdit can't be overriden
         if (in_array($roleId, array(ROLE_ID_MANAGER))) {
            $permitMetadataEdit = $setting->getAttribute('permitMetadataEdit');
         }
 
         $defaultStages = explode(',', $setting->getAttribute('stages'));
 
         // create a role associated with this user group
         $userGroup = $this->newDataObject();
         $userGroup->setRoleId($roleId);
         $userGroup->setContextId($contextId);
         $userGroup->setPermitSelfRegistration($permitSelfRegistration);
         $userGroup->setPermitMetadataEdit($permitMetadataEdit);
         $userGroup->setDefault(true);
 
         // insert the group into the DB
         $userGroupId = $this->insertObject($userGroup);
 
         // Install default groups for each stage
         if (is_array($defaultStages)) { // test for groups with no stage assignments
            foreach ($defaultStages as $stageId) {
               if (!empty($stageId) && $stageId <= WORKFLOW_STAGE_ID_PRODUCTION && $stageId >= WORKFLOW_STAGE_ID_SUBMISSION) {
                  $this->assignGroupToStage($contextId, $userGroupId, $stageId);
               }
            }
         }
 
         // add the i18n keys to the settings table so that they
         // can be used when a new locale is added/reloaded
         $this->updateSetting($userGroup->getId(), 'nameLocaleKey', $nameKey);
         $this->updateSetting($userGroup->getId(), 'abbrevLocaleKey', $abbrevKey);
 
         // install the settings in the current locale for this context
         foreach ($installedLocales as $locale) {
            $this->installLocale($locale, $contextId);
         }
      }
 
      return true;
   }
 
   function installLocale($locale, $contextId = null) {
      $userGroups = $this->getByContextId($contextId);
      while ($userGroup = $userGroups->next()) {
         $nameKey = $this->getSetting($userGroup->getId(), 'nameLocaleKey');
         $this->updateSetting($userGroup->getId(),
            'name',
            array($locale => __($nameKey, null, $locale)),
            'string',
            $locale,
            true
         );
 
         $abbrevKey = $this->getSetting($userGroup->getId(), 'abbrevLocaleKey');
         $this->updateSetting($userGroup->getId(),
            'abbrev',
            array($locale => __($abbrevKey, null, $locale)),
            'string',
            $locale,
            true
         );
      }
   }
 
   function deleteSettingsByLocale($locale) {
      return $this->update('DELETE FROM user_group_settings WHERE locale = ?', $locale);
   }
 
   function _getSearchSql($searchType, $search, $searchMatch, &$params) {
      $searchTypeMap = array(
         IDENTITY_SETTING_GIVENNAME => 'usgs.setting_value',
         IDENTITY_SETTING_FAMILYNAME => 'usfs.setting_value',
         USER_FIELD_USERNAME => 'u.username',
         USER_FIELD_EMAIL => 'u.email',
         USER_FIELD_AFFILIATION => 'us.setting_value',
      );
 
      $searchSql = '';
 
      if (!empty($search)) {
 
         if (!isset($searchTypeMap[$searchType])) {
            $str = $this->concat('COALESCE(usgs.setting_value,\'\')', 'COALESCE(usfs.setting_value,\'\')', 'u.email', 'COALESCE(us.setting_value,\'\')');
            $concatFields = ' ( LOWER(' . $str . ') LIKE ? OR LOWER(cves.setting_value) LIKE ? ) ';
 
            $search = strtolower($search);
 
            $words = preg_split('{\s+}', $search);
            $searchFieldMap = array();
 
            foreach ($words as $word) {
               $searchFieldMap[] = $concatFields;
               $term = '%' . $word . '%';
               array_push($params, $term, $term);
            }
 
            $searchSql .= ' AND (  ' . join(' AND ', $searchFieldMap) . '  ) ';
         } else {
            $fieldName = $searchTypeMap[$searchType];
            switch ($searchMatch) {
               case 'is':
                  $searchSql = "AND LOWER($fieldName) = LOWER(?)";
                  $params[] = $search;
                  break;
               case 'contains':
                  $searchSql = "AND LOWER($fieldName) LIKE LOWER(?)";
                  $params[] = '%' . $search . '%';
                  break;
               case 'startsWith':
                  $searchSql = "AND LOWER($fieldName) LIKE LOWER(?)";
                  $params[] = $search . '%';
                  break;
            }
         }
      } else {
         switch ($searchType) {
            case USER_FIELD_USERID:
               $searchSql = 'AND u.user_id = ?';
               break;
         }
      }
 
      $searchSql .= $this->userDao->getOrderBy(); // FIXME Add "sort field" parameter?
 
      return $searchSql;
   }
 
   //
   // Public helper methods
   //
 
   function getUserGroupsByStage($contextId, $stageId, $roleId = null, $dbResultRange = null) {
      $params = array((int) $contextId, (int) $stageId);
      if ($roleId) $params[] = (int) $roleId;
      return new DAOResultFactory(
         $this->retrieveRange(
            'SELECT  ug.*
            FROM  user_groups ug
               JOIN user_group_stage ugs ON (ug.user_group_id = ugs.user_group_id AND ug.context_id = ugs.context_id)
            WHERE ugs.context_id = ? AND
               ugs.stage_id = ?
               ' . ($roleId?'AND ug.role_id = ?':'') . '
            ORDER BY ug.role_id ASC',
            $params,
            $dbResultRange
         ),
         $this,
         '_returnFromRow'
      );
   }
 
   function getAssignedStagesByUserGroupId($contextId, $userGroupId) {
      $result = $this->retrieve(
         'SELECT  stage_id
         FROM  user_group_stage
         WHERE context_id = ? AND
            user_group_id = ?',
         array((int) $contextId, (int) $userGroupId)
      );
 
      $returner = array();
      while (!$result->EOF) {
         $stageId = $result->Fields('stage_id');
         $returner[$stageId] = WorkflowStageDAO::getTranslationKeyFromId($stageId);
         $result->MoveNext();
      }
 
      return $returner;
   }
 
   function userGroupAssignedToStage($userGroupId, $stageId) {
      $result = $this->retrieve(
         'SELECT COUNT(*)
         FROM  user_group_stage
         WHERE user_group_id = ? AND
         stage_id = ?',
         array((int) $userGroupId, (int) $stageId)
      );
 
      $returner = isset($result->fields[0]) && $result->fields[0] > 0 ? true : false;
 
      $result->Close();
      return $returner;
   }
 
   function userAssignmentExists($contextId, $userId, $stageId) {
      $result = $this->retrieve(
         'SELECT  COUNT(*)
         FROM  user_group_stage ugs,
         user_user_groups uug
         WHERE ugs.user_group_id = uug.user_group_id AND
         ugs.context_id = ? AND
         uug.user_id = ? AND
         ugs.stage_id = ?',
         array((int) $contextId, (int) $userId, (int) $stageId)
      );
 
      $returner = isset($result->fields[0]) && $result->fields[0] > 0 ? true : false;
 
      $result->Close();
      return $returner;
   }
 
   function getRecommendOnlyGroupIds($contextId, $roleId = null) {
      $params = array((int) $contextId);
      if ($roleId) $params[] = (int) $roleId;
 
      $result = $this->retrieve(
         'SELECT  ug.user_group_id
         FROM user_groups ug
         JOIN user_group_settings ugs ON (ugs.user_group_id = ug.user_group_id AND ugs.setting_name = \'recommendOnly\' AND ugs.setting_value = \'1\')
         WHERE ug.context_id = ?
         ' . ($roleId?' AND ug.role_id = ?':''),
         $params
      );
 
      $userGroupIds = array();
      while (!$result->EOF) {
         $userGroupIds[] = (int) $result->fields[0];
         $result->MoveNext();
      }
 
      $result->Close();
      return $userGroupIds;
   }
 
   function getPermitMetadataEditGroupIds($contextId, $roleId = null) {
      $params = array((int) $contextId);
      if ($roleId) $params[] = (int) $roleId;
 
      $result = $this->retrieve(
         'SELECT  ug.user_group_id
         FROM user_groups ug
         WHERE permit_metadata_edit = 1 AND
         ug.context_id = ?
         ' . ($roleId?' AND ug.role_id = ?':''),
         $params
      );
 
      $userGroupIds = array();
      while (!$result->EOF) {
         $userGroupIds[] = (int) $result->fields[0];
         $result->MoveNext();
      }
 
      $result->Close();
      return $userGroupIds;
   }
 
   static function getNotChangeMetadataEditPermissionRoles() {
      return array(ROLE_ID_MANAGER);
   }
}