CRM/Core/BAO/OpenID.php

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