CRM/Core/Page/AJAX/Location.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  *
  33  */
  34
  35 /**
  36  * This class contains all the function that are called using AJAX
  37  */
  38 class CRM_Core_Page_AJAX_Location {
  39
  40   /**
  41    * FIXME: we should make this method like getLocBlock() OR use the same method and
  42    * remove this one.
  43    *
  44    * obtain the location of given contact-id.
  45    * This method is used by on-behalf-of form to dynamically generate poulate the
  46    * location field values for selected permissioned contact.
  47    */
  48   public static function getPermissionedLocation() {
  49     $cid = CRM_Utils_Request::retrieve('cid', 'Integer', CRM_Core_DAO::$_nullObject, TRUE);
  50     $ufId = CRM_Utils_Request::retrieve('ufId', 'Integer', CRM_Core_DAO::$_nullObject, TRUE);
  51
  52     // Verify user id
  53     $user = CRM_Utils_Request::retrieve('uid', 'Integer', CRM_Core_DAO::$_nullObject, FALSE, CRM_Core_Session::singleton()
  54         ->get('userID'));
  55     if (empty($user) || (CRM_Utils_Request::retrieve('cs', 'String', $form, FALSE) && !CRM_Contact_BAO_Contact_Permission::validateChecksumContact($user, CRM_Core_DAO::$_nullObject, FALSE))
  56     ) {
  57       CRM_Utils_System::civiExit();
  58     }
  59
  60     // Verify user permission on related contact
  61     $organizations = CRM_Contact_BAO_Relationship::getPermissionedContacts($user, NULL, NULL, 'Organization');
  62     if (!isset($organizations[$cid])) {
  63       CRM_Utils_System::civiExit();
  64     }
  65
  66     $values = array();
  67     $entityBlock = array('contact_id' => $cid);
  68     $location = CRM_Core_BAO_Location::getValues($entityBlock);
  69
  70     $config = CRM_Core_Config::singleton();
  71     $addressSequence = array_flip($config->addressSequence());
  72
  73     $profileFields = CRM_Core_BAO_UFGroup::getFields($ufId, FALSE, CRM_Core_Action::VIEW, NULL, NULL, FALSE,
  74       NULL, FALSE, NULL, CRM_Core_Permission::CREATE, NULL
  75     );
  76     $website = CRM_Core_BAO_Website::getValues($entityBlock, $values);
  77
  78     foreach ($location as $fld => $values) {
  79       if (is_array($values) && !empty($values)) {
  80         $locType = $values[1]['location_type_id'];
  81         if ($fld == 'email') {
  82           $elements["onbehalf_{$fld}-{$locType}"] = array(
  83             'type' => 'Text',
  84             'value' => $location[$fld][1][$fld],
  85           );
  86           unset($profileFields["{$fld}-{$locType}"]);
  87         }
  88         elseif ($fld == 'phone') {
  89           $phoneTypeId = $values[1]['phone_type_id'];
  90           $elements["onbehalf_{$fld}-{$locType}-{$phoneTypeId}"] = array(
  91             'type' => 'Text',
  92             'value' => $location[$fld][1][$fld],
  93           );
  94           unset($profileFields["{$fld}-{$locType}-{$phoneTypeId}"]);
  95         }
  96         elseif ($fld == 'im') {
  97           $providerId = $values[1]['provider_id'];
  98           $elements["onbehalf_{$fld}-{$locType}"] = array(
  99             'type' => 'Text',
 100             'value' => $location[$fld][1][$fld],
 101           );
 102           $elements["onbehalf_{$fld}-{$locType}provider_id"] = array(
 103             'type' => 'Select',
 104             'value' => $location[$fld][1]['provider_id'],
 105           );
 106           unset($profileFields["{$fld}-{$locType}-{$providerId}"]);
 107         }
 108       }
 109     }
 110
 111     if (!empty($website)) {
 112       foreach ($website as $key => $val) {
 113         $websiteTypeId = $values[1]['website_type_id'];
 114         $elements["onbehalf_url-1"] = array(
 115           'type' => 'Text',
 116           'value' => $website[1]['url'],
 117         );
 118         $elements["onbehalf_url-1-website_type_id"] = array(
 119           'type' => 'Select',
 120           'value' => $website[1]['website_type_id'],
 121         );
 122         unset($profileFields["url-1"]);
 123       }
 124     }
 125
 126     $locTypeId = isset($location['address'][1]) ? $location['address'][1]['location_type_id'] : NULL;
 127     $addressFields = array(
 128       'street_address',
 129       'supplemental_address_1',
 130       'supplemental_address_2',
 131       'supplemental_address_3',
 132       'city',
 133       'postal_code',
 134       'county',
 135       'state_province',
 136       'country',
 137     );
 138
 139     foreach ($addressFields as $field) {
 140       if (array_key_exists($field, $addressSequence)) {
 141         $addField = $field;
 142         $type = 'Text';
 143         if (in_array($field, array('state_province', 'country', 'county'))) {
 144           $addField = "{$field}_id";
 145           $type = 'Select';
 146         }
 147         $elements["onbehalf_{$field}-{$locTypeId}"] = array(
 148           'type' => $type,
 149           'value' => isset($location['address'][1]) ? CRM_Utils_Array::value($addField,
 150             $location['address'][1]) : NULL,
 151         );
 152         unset($profileFields["{$field}-{$locTypeId}"]);
 153       }
 154     }
 155
 156     //set custom field defaults
 157     $defaults = array();
 158     CRM_Core_BAO_UFGroup::setProfileDefaults($cid, $profileFields, $defaults, TRUE, NULL, NULL, TRUE);
 159
 160     if (!empty($defaults)) {
 161       foreach ($profileFields as $key => $val) {
 162         if (array_key_exists($key, $defaults)) {
 163           $htmlType = CRM_Utils_Array::value('html_type', $val);
 164           if ($htmlType == 'Radio') {
 165             $elements["onbehalf_{$key}"]['type'] = $htmlType;
 166             $elements["onbehalf_{$key}"]['value'] = $defaults[$key];
 167           }
 168           elseif ($htmlType == 'CheckBox') {
 169             $elements["onbehalf_{$key}"]['type'] = $htmlType;
 170             foreach ($defaults[$key] as $k => $v) {
 171               $elements["onbehalf_{$key}"]['value'][$k] = $v;
 172             }
 173           }
 174           elseif (strstr($htmlType, 'Multi-Select')) {
 175             $elements["onbehalf_{$key}"]['type'] = 'Multi-Select';
 176             $elements["onbehalf_{$key}"]['value'] = array_values($defaults[$key]);
 177           }
 178           elseif ($htmlType == 'Autocomplete-Select') {
 179             $elements["onbehalf_{$key}"]['type'] = $htmlType;
 180             $elements["onbehalf_{$key}"]['value'] = $defaults[$key];
 181           }
 182           elseif ($htmlType == 'Select Date') {
 183             $elements["onbehalf_{$key}"]['type'] = $htmlType;
 184             //CRM-18349, date value must be ISO formatted before being set as a default value for crmDatepicker custom field
 185             $elements["onbehalf_{$key}"]['value'] = CRM_Utils_Date::processDate($defaults[$key], NULL, FALSE, 'Y-m-d G:i:s');
 186           }
 187           else {
 188             $elements["onbehalf_{$key}"]['type'] = $htmlType;
 189             $elements["onbehalf_{$key}"]['value'] = $defaults[$key];
 190           }
 191         }
 192         else {
 193           $elements["onbehalf_{$key}"]['value'] = '';
 194         }
 195       }
 196     }
 197
 198     CRM_Utils_JSON::output($elements);
 199   }
 200
 201   public static function jqState() {
 202     CRM_Utils_JSON::output(CRM_Core_BAO_Location::getChainSelectValues($_GET['_value'], 'country'));
 203   }
 204
 205   public static function jqCounty() {
 206     CRM_Utils_JSON::output(CRM_Core_BAO_Location::getChainSelectValues($_GET['_value'], 'stateProvince'));
 207   }
 208
 209   public static function getLocBlock() {
 210     // i wish i could retrieve loc block info based on loc_block_id,
 211     // Anyway, lets retrieve an event which has loc_block_id set to 'lbid'.
 212     if ($_REQUEST['lbid']) {
 213       $params = array('1' => array($_REQUEST['lbid'], 'Integer'));
 214       $eventId = CRM_Core_DAO::singleValueQuery('SELECT id FROM civicrm_event WHERE loc_block_id=%1 LIMIT 1', $params);
 215     }
 216     // now lets use the event-id obtained above, to retrieve loc block information.
 217     if ($eventId) {
 218       $params = array('entity_id' => $eventId, 'entity_table' => 'civicrm_event');
 219       // second parameter is of no use, but since required, lets use the same variable.
 220       $location = CRM_Core_BAO_Location::getValues($params, $params);
 221     }
 222
 223     $result = array();
 224     $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 225       'address_options', TRUE, NULL, TRUE
 226     );
 227     // lets output only required fields.
 228     foreach ($addressOptions as $element => $isSet) {
 229       if ($isSet && (!in_array($element, array(
 230           'im',
 231           'openid',
 232         )))
 233       ) {
 234         if (in_array($element, array(
 235           'country',
 236           'state_province',
 237           'county',
 238         ))) {
 239           $element .= '_id';
 240         }
 241         elseif ($element == 'address_name') {
 242           $element = 'name';
 243         }
 244         $fld = "address[1][{$element}]";
 245         $value = CRM_Utils_Array::value($element, $location['address'][1]);
 246         $value = $value ? $value : "";
 247         $result[str_replace(array(
 248           '][',
 249           '[',
 250           "]",
 251         ), array('_', '_', ''), $fld)] = $value;
 252       }
 253     }
 254
 255     foreach (array(
 256                'email',
 257                'phone_type_id',
 258                'phone',
 259              ) as $element) {
 260       $block = ($element == 'phone_type_id') ? 'phone' : $element;
 261       for ($i = 1; $i < 3; $i++) {
 262         $fld = "{$block}[{$i}][{$element}]";
 263         $value = CRM_Utils_Array::value($element, $location[$block][$i]);
 264         $value = $value ? $value : "";
 265         $result[str_replace(array(
 266           '][',
 267           '[',
 268           "]",
 269         ), array('_', '_', ''), $fld)] = $value;
 270       }
 271     }
 272
 273     // set the message if loc block is being used by more than one event.
 274     $result['count_loc_used'] = CRM_Event_BAO_Event::countEventsUsingLocBlockId($_REQUEST['lbid']);
 275
 276     CRM_Utils_JSON::output($result);
 277   }
 278
 279 }