| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.7 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 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-2015 |
| 32 | * $Id$ |
| 33 | * |
| 34 | */ |
| 35 | |
| 36 | /** |
| 37 | * This class contains function for Open Id |
| 38 | */ |
| 39 | class CRM_Core_BAO_OpenID extends CRM_Core_DAO_OpenID { |
| 40 | |
| 41 | /** |
| 42 | * Takes an associative array and adds OpenID. |
| 43 | * |
| 44 | * @param array $params |
| 45 | * (reference ) an assoc array of name/value pairs. |
| 46 | * |
| 47 | * @return object |
| 48 | * CRM_Core_BAO_OpenID object on success, null otherwise |
| 49 | */ |
| 50 | public static function add(&$params) { |
| 51 | $hook = empty($params['id']) ? 'create' : 'edit'; |
| 52 | CRM_Utils_Hook::pre($hook, 'OpenID', CRM_Utils_Array::value('id', $params), $params); |
| 53 | |
| 54 | $openId = new CRM_Core_DAO_OpenID(); |
| 55 | $openId->copyValues($params); |
| 56 | $openId->save(); |
| 57 | |
| 58 | CRM_Utils_Hook::post($hook, 'OpenID', $openId->id, $openId); |
| 59 | return $openId; |
| 60 | } |
| 61 | |
| 62 | /** |
| 63 | * Given the list of params in the params array, fetch the object |
| 64 | * and store the values in the values array |
| 65 | * |
| 66 | * @param array $entityBlock |
| 67 | * Input parameters to find object. |
| 68 | * |
| 69 | * @return mixed |
| 70 | */ |
| 71 | public static function &getValues($entityBlock) { |
| 72 | return CRM_Core_BAO_Block::getValues('openid', $entityBlock); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Returns whether or not this OpenID is allowed to login. |
| 77 | * |
| 78 | * @param string $identity_url |
| 79 | * The OpenID to check. |
| 80 | * |
| 81 | * @return bool |
| 82 | */ |
| 83 | public static function isAllowedToLogin($identity_url) { |
| 84 | $openId = new CRM_Core_DAO_OpenID(); |
| 85 | $openId->openid = $identity_url; |
| 86 | if ($openId->find(TRUE)) { |
| 87 | return $openId->allowed_to_login == 1; |
| 88 | } |
| 89 | return FALSE; |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Get all the openids for a specified contact_id, with the primary openid being first |
| 94 | * |
| 95 | * @param int $id |
| 96 | * The contact id. |
| 97 | * |
| 98 | * @param bool $updateBlankLocInfo |
| 99 | * |
| 100 | * @return array |
| 101 | * the array of openid's |
| 102 | */ |
| 103 | public static function allOpenIDs($id, $updateBlankLocInfo = FALSE) { |
| 104 | if (!$id) { |
| 105 | return NULL; |
| 106 | } |
| 107 | |
| 108 | $query = " |
| 109 | SELECT civicrm_openid.openid, civicrm_location_type.name as locationType, civicrm_openid.is_primary as is_primary, |
| 110 | civicrm_openid.allowed_to_login as allowed_to_login, civicrm_openid.id as openid_id, |
| 111 | civicrm_openid.location_type_id as locationTypeId |
| 112 | FROM civicrm_contact |
| 113 | LEFT JOIN civicrm_openid ON ( civicrm_openid.contact_id = civicrm_contact.id ) |
| 114 | LEFT JOIN civicrm_location_type ON ( civicrm_openid.location_type_id = civicrm_location_type.id ) |
| 115 | WHERE |
| 116 | civicrm_contact.id = %1 |
| 117 | ORDER BY |
| 118 | civicrm_openid.is_primary DESC, openid_id ASC "; |
| 119 | $params = array(1 => array($id, 'Integer')); |
| 120 | |
| 121 | $openids = $values = array(); |
| 122 | $dao = CRM_Core_DAO::executeQuery($query, $params); |
| 123 | $count = 1; |
| 124 | while ($dao->fetch()) { |
| 125 | $values = array( |
| 126 | 'locationType' => $dao->locationType, |
| 127 | 'is_primary' => $dao->is_primary, |
| 128 | 'id' => $dao->openid_id, |
| 129 | 'openid' => $dao->openid, |
| 130 | 'locationTypeId' => $dao->locationTypeId, |
| 131 | 'allowed_to_login' => $dao->allowed_to_login, |
| 132 | ); |
| 133 | |
| 134 | if ($updateBlankLocInfo) { |
| 135 | $openids[$count++] = $values; |
| 136 | } |
| 137 | else { |
| 138 | $openids[$dao->openid_id] = $values; |
| 139 | } |
| 140 | } |
| 141 | return $openids; |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * Call common delete function. |
| 146 | */ |
| 147 | public static function del($id) { |
| 148 | return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('OpenID', $id); |
| 149 | } |
| 150 | |
| 151 | } |