CRM/Core/Permission/Drupal.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  *
  38  */
  39 class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase {
  40
  41   /**
  42    * Is this user someone with access for the entire system.
  43    *
  44    * @var boolean
  45    */
  46   protected $_viewAdminUser = FALSE;
  47   protected $_editAdminUser = FALSE;
  48
  49   /**
  50    * Am in in view permission or edit permission?
  51    * @var boolean
  52    */
  53   protected $_viewPermission = FALSE;
  54   protected $_editPermission = FALSE;
  55
  56   /**
  57    * The current set of permissioned groups for the user.
  58    *
  59    * @var array
  60    */
  61   protected $_viewPermissionedGroups;
  62   protected $_editPermissionedGroups;
  63
  64   /**
  65    * Given a permission string, check for access requirements
  66    *
  67    * @param string $str
  68    *   The permission to check.
  69    *
  70    * @param int $userId
  71    *
  72    * @return bool
  73    *   true if yes, else false
  74    */
  75   public function check($str, $userId = NULL) {
  76     $str = $this->translatePermission($str, 'Drupal', [
  77       'view user account' => 'access user profiles',
  78       'administer users' => 'administer users',
  79     ]);
  80     if ($str == CRM_Core_Permission::ALWAYS_DENY_PERMISSION) {
  81       return FALSE;
  82     }
  83     if ($str == CRM_Core_Permission::ALWAYS_ALLOW_PERMISSION) {
  84       return TRUE;
  85     }
  86     if (function_exists('user_access')) {
  87       $account = NULL;
  88       if ($userId) {
  89         $account = user_load($userId);
  90       }
  91       return user_access($str, $account);
  92     }
  93     return TRUE;
  94   }
  95
  96   /**
  97    * Given a roles array, check for access requirements
  98    *
  99    * @param array $array
 100    *   The roles to check.
 101    *
 102    * @return bool
 103    *   true if yes, else false
 104    */
 105   public function checkGroupRole($array) {
 106     if (function_exists('user_load') && isset($array)) {
 107       $user = user_load($GLOBALS['user']->uid);
 108       //if giver roles found in user roles - return true
 109       foreach ($array as $key => $value) {
 110         if (in_array($value, $user->roles)) {
 111           return TRUE;
 112         }
 113       }
 114     }
 115     return FALSE;
 116   }
 117
 118   /**
 119    * @inheritDoc
 120    */
 121   public function isModulePermissionSupported() {
 122     return TRUE;
 123   }
 124
 125   /**
 126    * @inheritDoc
 127    */
 128   public function upgradePermissions($permissions) {
 129     if (empty($permissions)) {
 130       throw new CRM_Core_Exception("Cannot upgrade permissions: permission list missing");
 131     }
 132     $query = db_delete('role_permission')
 133       ->condition('module', 'civicrm')
 134       ->condition('permission', array_keys($permissions), 'NOT IN');
 135     $query->execute();
 136   }
 137
 138   /**
 139    * Get all the contact emails for users that have a specific permission.
 140    *
 141    * @param string $permissionName
 142    *   Name of the permission we are interested in.
 143    *
 144    * @return string
 145    *   a comma separated list of email addresses
 146    */
 147   public function permissionEmails($permissionName) {
 148     static $_cache = [];
 149
 150     if (isset($_cache[$permissionName])) {
 151       return $_cache[$permissionName];
 152     }
 153
 154     $uids = [];
 155     $sql = "
 156       SELECT {users}.uid, {role_permission}.permission
 157       FROM {users}
 158       JOIN {users_roles}
 159         ON {users}.uid = {users_roles}.uid
 160       JOIN {role_permission}
 161         ON {role_permission}.rid = {users_roles}.rid
 162       WHERE {role_permission}.permission = '{$permissionName}'
 163         AND {users}.status = 1
 164     ";
 165
 166     $result = db_query($sql);
 167     foreach ($result as $record) {
 168       $uids[] = $record->uid;
 169     }
 170
 171     $_cache[$permissionName] = self::getContactEmails($uids);
 172     return $_cache[$permissionName];
 173   }
 174
 175 }