CRM/Core/BAO/OpenID.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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         (reference ) an assoc array of name/value pairs
  45    *
  46    * @return object       CRM_Core_BAO_OpenID object on success, null otherwise
  47    * @access public
  48    * @static
  49    */
  50   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   input parameters to find object
  67    *
  68    * @return mixed
  69    * @access public
  70    * @static
  71    */
  72   static function &getValues($entityBlock) {
  73     return CRM_Core_BAO_Block::getValues('openid', $entityBlock);
  74   }
  75
  76   /**
  77    * Returns whether or not this OpenID is allowed to login
  78    *
  79    * @param  string  $identity_url the OpenID to check
  80    *
  81    * @return boolean
  82    * @access public
  83    * @static
  84    */
  85   static function isAllowedToLogin($identity_url) {
  86     $openId = new CRM_Core_DAO_OpenID();
  87     $openId->openid = $identity_url;
  88     if ($openId->find(TRUE)) {
  89       return $openId->allowed_to_login == 1;
  90     }
  91     return FALSE;
  92   }
  93
  94   /**
  95    * Get all the openids for a specified contact_id, with the primary openid being first
  96    *
  97    * @param int $id the contact id
  98    *
  99    * @param bool $updateBlankLocInfo
 100    *
 101    * @return array  the array of openid's
 102    * @access public
 103    * @static
 104    */
 105   static function allOpenIDs($id, $updateBlankLocInfo = FALSE) {
 106     if (!$id) {
 107       return NULL;
 108     }
 109
 110     $query = "
 111 SELECT civicrm_openid.openid, civicrm_location_type.name as locationType, civicrm_openid.is_primary as is_primary,
 112 civicrm_openid.allowed_to_login as allowed_to_login, civicrm_openid.id as openid_id,
 113 civicrm_openid.location_type_id as locationTypeId
 114 FROM      civicrm_contact
 115 LEFT JOIN civicrm_openid ON ( civicrm_openid.contact_id = civicrm_contact.id )
 116 LEFT JOIN civicrm_location_type ON ( civicrm_openid.location_type_id = civicrm_location_type.id )
 117 WHERE
 118   civicrm_contact.id = %1
 119 ORDER BY
 120   civicrm_openid.is_primary DESC,  openid_id ASC ";
 121     $params = array(1 => array($id, 'Integer'));
 122
 123     $openids = $values = array();
 124     $dao     = CRM_Core_DAO::executeQuery($query, $params);
 125     $count   = 1;
 126     while ($dao->fetch()) {
 127       $values = array(
 128         'locationType' => $dao->locationType,
 129         'is_primary' => $dao->is_primary,
 130         'id' => $dao->openid_id,
 131         'openid' => $dao->openid,
 132         'locationTypeId' => $dao->locationTypeId,
 133         'allowed_to_login' => $dao->allowed_to_login,
 134       );
 135
 136       if ($updateBlankLocInfo) {
 137         $openids[$count++] = $values;
 138       }
 139       else {
 140         $openids[$dao->openid_id] = $values;
 141       }
 142     }
 143     return $openids;
 144   }
 145
 146   /**
 147    * Call common delete function
 148    */
 149   static function del($id) {
 150     return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('OpenID', $id);
 151   }
 152 }
 153