CRM/Core/BAO/CustomField.php

   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  */
  33
  34 /**
  35  * Business objects for managing custom data fields.
  36  */
  37 class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField {
  38
  39   /**
  40    * Array for valid combinations of data_type & descriptions.
  41    *
  42    * @var array
  43    */
  44   public static $_dataType = NULL;
  45
  46   /**
  47    * Array for valid combinations of data_type & html_type.
  48    *
  49    * @var array
  50    */
  51   public static $_dataToHtml = NULL;
  52
  53   /**
  54    * Array to hold (formatted) fields for import
  55    *
  56    * @var array
  57    */
  58   public static $_importFields = NULL;
  59
  60   /**
  61    * Build and retrieve the list of data types and descriptions.
  62    *
  63    * @return array
  64    *   Data type => Description
  65    */
  66   public static function &dataType() {
  67     if (!(self::$_dataType)) {
  68       self::$_dataType = array(
  69         'String' => ts('Alphanumeric'),
  70         'Int' => ts('Integer'),
  71         'Float' => ts('Number'),
  72         'Money' => ts('Money'),
  73         'Memo' => ts('Note'),
  74         'Date' => ts('Date'),
  75         'Boolean' => ts('Yes or No'),
  76         'StateProvince' => ts('State/Province'),
  77         'Country' => ts('Country'),
  78         'File' => ts('File'),
  79         'Link' => ts('Link'),
  80         'ContactReference' => ts('Contact Reference'),
  81       );
  82     }
  83     return self::$_dataType;
  84   }
  85
  86   /**
  87    * Get data to html array.
  88    *
  89    * (Does this caching achieve anything?)
  90    *
  91    * @return array
  92    */
  93   public static function dataToHtml() {
  94     if (!self::$_dataToHtml) {
  95       self::$_dataToHtml = array(
  96         array(
  97           'Text' => 'Text',
  98           'Select' => 'Select',
  99           'Radio' => 'Radio',
 100           'CheckBox' => 'CheckBox',
 101           'Multi-Select' => 'Multi-Select',
 102           'AdvMulti-Select' => 'AdvMulti-Select',
 103           'Autocomplete-Select' => 'Autocomplete-Select',
 104         ),
 105         array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
 106         array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
 107         array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
 108         array('TextArea' => 'TextArea', 'RichTextEditor' => 'RichTextEditor'),
 109         array('Date' => 'Select Date'),
 110         array('Radio' => 'Radio'),
 111         array('StateProvince' => 'Select State/Province', 'Multi-Select' => 'Multi-Select State/Province'),
 112         array('Country' => 'Select Country', 'Multi-Select' => 'Multi-Select Country'),
 113         array('File' => 'File'),
 114         array('Link' => 'Link'),
 115         array('ContactReference' => 'Autocomplete-Select'),
 116       );
 117     }
 118     return self::$_dataToHtml;
 119   }
 120
 121   /**
 122    * Takes an associative array and creates a custom field object.
 123    *
 124    * This function is invoked from within the web form layer and also from the api layer
 125    *
 126    * @param array $params
 127    *   (reference) an assoc array of name/value pairs.
 128    *
 129    * @return CRM_Core_DAO_CustomField
 130    */
 131   public static function create(&$params) {
 132     $origParams = array_merge(array(), $params);
 133
 134     if (!isset($params['id'])) {
 135       if (!isset($params['column_name'])) {
 136         // if add mode & column_name not present, calculate it.
 137         $params['column_name'] = strtolower(CRM_Utils_String::munge($params['label'], '_', 32));
 138       }
 139       if (!isset($params['name'])) {
 140         $params['name'] = CRM_Utils_String::munge($params['label'], '_', 64);
 141       }
 142     }
 143     else {
 144       $params['column_name'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
 145         $params['id'],
 146         'column_name'
 147       );
 148     }
 149     $columnName = $params['column_name'];
 150
 151     $indexExist = FALSE;
 152     //as during create if field is_searchable we had created index.
 153     if (!empty($params['id'])) {
 154       $indexExist = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', $params['id'], 'is_searchable');
 155     }
 156
 157     switch (CRM_Utils_Array::value('html_type', $params)) {
 158       case 'Select Date':
 159         if (empty($params['date_format'])) {
 160           $config = CRM_Core_Config::singleton();
 161           $params['date_format'] = $config->dateInputFormat;
 162         }
 163         break;
 164
 165       case 'CheckBox':
 166       case 'AdvMulti-Select':
 167       case 'Multi-Select':
 168         if (isset($params['default_checkbox_option'])) {
 169           $tempArray = array_keys($params['default_checkbox_option']);
 170           $defaultArray = array();
 171           foreach ($tempArray as $k => $v) {
 172             if ($params['option_value'][$v]) {
 173               $defaultArray[] = $params['option_value'][$v];
 174             }
 175           }
 176
 177           if (!empty($defaultArray)) {
 178             // also add the separator before and after the value per new convention (CRM-1604)
 179             $params['default_value'] = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $defaultArray) . CRM_Core_DAO::VALUE_SEPARATOR;
 180           }
 181         }
 182         else {
 183           if (!empty($params['default_option']) && isset($params['option_value'][$params['default_option']])
 184           ) {
 185             $params['default_value'] = $params['option_value'][$params['default_option']];
 186           }
 187         }
 188         break;
 189     }
 190
 191     $transaction = new CRM_Core_Transaction();
 192     // create any option group & values if required
 193     if ($params['html_type'] != 'Text' &&
 194       in_array($params['data_type'], array(
 195         'String',
 196         'Int',
 197         'Float',
 198         'Money',
 199       ))
 200     ) {
 201
 202       $tableName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup',
 203         $params['custom_group_id'],
 204         'table_name'
 205       );
 206
 207       //CRM-16659: if option_value then create an option group for this custom field.
 208       if ($params['option_type'] == 1 && (empty($params['option_group_id']) || !empty($params['option_value']))) {
 209         // first create an option group for this custom group
 210         $optionGroup = new CRM_Core_DAO_OptionGroup();
 211         $optionGroup->name = "{$columnName}_" . date('YmdHis');
 212         $optionGroup->title = $params['label'];
 213         $optionGroup->is_active = 1;
 214         $optionGroup->save();
 215         $params['option_group_id'] = $optionGroup->id;
 216         if (!empty($params['option_value']) && is_array($params['option_value'])) {
 217           foreach ($params['option_value'] as $k => $v) {
 218             if (strlen(trim($v))) {
 219               $optionValue = new CRM_Core_DAO_OptionValue();
 220               $optionValue->option_group_id = $optionGroup->id;
 221               $optionValue->label = $params['option_label'][$k];
 222               $optionValue->name = CRM_Utils_String::titleToVar($params['option_label'][$k]);
 223               switch ($params['data_type']) {
 224                 case 'Money':
 225                   $optionValue->value = CRM_Utils_Rule::cleanMoney($v);
 226                   break;
 227
 228                 case 'Int':
 229                   $optionValue->value = intval($v);
 230                   break;
 231
 232                 case 'Float':
 233                   $optionValue->value = floatval($v);
 234                   break;
 235
 236                 default:
 237                   $optionValue->value = trim($v);
 238               }
 239
 240               $optionValue->weight = $params['option_weight'][$k];
 241               $optionValue->is_active = CRM_Utils_Array::value($k, $params['option_status'], FALSE);
 242               $optionValue->save();
 243             }
 244           }
 245         }
 246       }
 247     }
 248
 249     // check for orphan option groups
 250     if (!empty($params['option_group_id'])) {
 251       if (!empty($params['id'])) {
 252         self::fixOptionGroups($params['id'], $params['option_group_id']);
 253       }
 254
 255       // if we do not have a default value
 256       // retrieve it from one of the other custom fields which use this option group
 257       if (empty($params['default_value'])) {
 258         //don't insert only value separator as default value, CRM-4579
 259         $defaultValue = self::getOptionGroupDefault($params['option_group_id'],
 260           $params['html_type']
 261         );
 262
 263         if (!CRM_Utils_System::isNull(explode(CRM_Core_DAO::VALUE_SEPARATOR,
 264           $defaultValue
 265         ))
 266         ) {
 267           $params['default_value'] = $defaultValue;
 268         }
 269       }
 270     }
 271
 272     // since we need to save option group id :)
 273     if (!isset($params['attributes']) && strtolower($params['html_type']) == 'textarea') {
 274       $params['attributes'] = 'rows=4, cols=60';
 275     }
 276
 277     $customField = new CRM_Core_DAO_CustomField();
 278     $customField->copyValues($params);
 279     $customField->is_required = CRM_Utils_Array::value('is_required', $params, FALSE);
 280     $customField->is_searchable = CRM_Utils_Array::value('is_searchable', $params, FALSE);
 281     $customField->in_selector = CRM_Utils_Array::value('in_selector', $params, FALSE);
 282     $customField->is_search_range = CRM_Utils_Array::value('is_search_range', $params, FALSE);
 283     //CRM-15792 - Custom field gets disabled if is_active not set
 284     $customField->is_active = CRM_Utils_Array::value('is_active', $params, TRUE);
 285     $customField->is_view = CRM_Utils_Array::value('is_view', $params, FALSE);
 286     $customField->save();
 287
 288     // make sure all values are present in the object for further processing
 289     $customField->find(TRUE);
 290
 291     $triggerRebuild = CRM_Utils_Array::value('triggerRebuild', $params, TRUE);
 292     //create/drop the index when we toggle the is_searchable flag
 293     if (!empty($params['id'])) {
 294       self::createField($customField, 'modify', $indexExist, $triggerRebuild);
 295     }
 296     else {
 297       if (!isset($origParams['column_name'])) {
 298         $columnName .= "_{$customField->id}";
 299         $params['column_name'] = $columnName;
 300       }
 301       $customField->column_name = $columnName;
 302       $customField->save();
 303       // make sure all values are present in the object
 304       $customField->find(TRUE);
 305
 306       $indexExist = FALSE;
 307       self::createField($customField, 'add', $indexExist, $triggerRebuild);
 308     }
 309
 310     // complete transaction
 311     $transaction->commit();
 312
 313     CRM_Utils_System::flushCache();
 314
 315     return $customField;
 316   }
 317
 318   /**
 319    * Fetch object based on array of properties.
 320    *
 321    * @param array $params
 322    *   (reference ) an assoc array of name/value pairs.
 323    * @param array $defaults
 324    *   (reference ) an assoc array to hold the flattened values.
 325    *
 326    * @return CRM_Core_DAO_CustomField
 327    */
 328   public static function retrieve(&$params, &$defaults) {
 329     return CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
 330   }
 331
 332   /**
 333    * Update the is_active flag in the db.
 334    *
 335    * @param int $id
 336    *   Id of the database record.
 337    * @param bool $is_active
 338    *   Value we want to set the is_active field.
 339    *
 340    * @return Object
 341    *   DAO object on success, null otherwise
 342    */
 343   public static function setIsActive($id, $is_active) {
 344
 345     CRM_Utils_System::flushCache();
 346
 347     //enable-disable CustomField
 348     CRM_Core_BAO_UFField::setUFField($id, $is_active);
 349     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_CustomField', $id, 'is_active', $is_active);
 350   }
 351
 352   /**
 353    * Get the field title.
 354    *
 355    * @param int $id
 356    *   Id of field.
 357    *
 358    * @return string
 359    *   name
 360    */
 361   public static function getTitle($id) {
 362     return CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', $id, 'label');
 363   }
 364
 365   /**
 366    * Store and return an array of all active custom fields.
 367    *
 368    * @param string $customDataType
 369    *   Type of Custom Data; empty is a synonym for "all contact data types".
 370    * @param bool $showAll
 371    *   If true returns all fields (includes disabled fields).
 372    * @param bool $inline
 373    *   If true returns all inline fields (includes disabled fields).
 374    * @param int $customDataSubType
 375    *   Custom Data sub type value.
 376    * @param int $customDataSubName
 377    *   Custom Data sub name value.
 378    * @param bool $onlyParent
 379    *   Return only top level custom data, for eg, only Participant and ignore subname and subtype.
 380    * @param bool $onlySubType
 381    *   Return only custom data for subtype.
 382    * @param bool $checkPermission
 383    *   If false, do not include permissioning clause.
 384    *
 385    * @return array
 386    *   an array of active custom fields.
 387    */
 388   public static function &getFields(
 389     $customDataType = 'Individual',
 390     $showAll = FALSE,
 391     $inline = FALSE,
 392     $customDataSubType = NULL,
 393     $customDataSubName = NULL,
 394     $onlyParent = FALSE,
 395     $onlySubType = FALSE,
 396     $checkPermission = TRUE
 397   ) {
 398     if (empty($customDataType)) {
 399       $customDataType = array('Contact', 'Individual', 'Organization', 'Household');
 400     }
 401     if ($customDataType && !is_array($customDataType)) {
 402
 403       if (in_array($customDataType, CRM_Contact_BAO_ContactType::subTypes())) {
 404         // This is the case when getFieldsForImport() requires fields
 405         // limited strictly to a subtype.
 406         $customDataSubType = $customDataType;
 407         $customDataType = CRM_Contact_BAO_ContactType::getBasicType($customDataType);
 408         $onlySubType = TRUE;
 409       }
 410
 411       if (in_array($customDataType, array_keys(CRM_Core_SelectValues::customGroupExtends()))) {
 412         // this makes the method flexible to support retrieving fields
 413         // for multiple extends value.
 414         $customDataType = array($customDataType);
 415       }
 416     }
 417
 418     $customDataSubType = CRM_Utils_Array::explodePadded($customDataSubType);
 419
 420     if (is_array($customDataType)) {
 421       $cacheKey = implode('_', $customDataType);
 422     }
 423     else {
 424       $cacheKey = $customDataType;
 425     }
 426
 427     $cacheKey .= !empty($customDataSubType) ? ('_' . implode('_', $customDataSubType)) : '_0';
 428     $cacheKey .= $customDataSubName ? "{$customDataSubName}_" : '_0';
 429     $cacheKey .= $showAll ? '_1' : '_0';
 430     $cacheKey .= $inline ? '_1_' : '_0_';
 431     $cacheKey .= $onlyParent ? '_1_' : '_0_';
 432     $cacheKey .= $onlySubType ? '_1_' : '_0_';
 433     $cacheKey .= $checkPermission ? '_1_' : '_0_';
 434
 435     $cgTable = CRM_Core_DAO_CustomGroup::getTableName();
 436
 437     // also get the permission stuff here
 438     if ($checkPermission) {
 439       $permissionClause = CRM_Core_Permission::customGroupClause(CRM_Core_Permission::VIEW,
 440         "{$cgTable}."
 441       );
 442     }
 443     else {
 444       $permissionClause = '(1)';
 445     }
 446
 447     // lets md5 permission clause and take first 8 characters
 448     $cacheKey .= substr(md5($permissionClause), 0, 8);
 449
 450     if (strlen($cacheKey) > 40) {
 451       $cacheKey = md5($cacheKey);
 452     }
 453
 454     if (!self::$_importFields ||
 455       CRM_Utils_Array::value($cacheKey, self::$_importFields) === NULL
 456     ) {
 457       if (!self::$_importFields) {
 458         self::$_importFields = array();
 459       }
 460
 461       // check if we can retrieve from database cache
 462       $fields = CRM_Core_BAO_Cache::getItem('contact fields', "custom importableFields $cacheKey");
 463
 464       if ($fields === NULL) {
 465         $cfTable = self::getTableName();
 466
 467         $extends = '';
 468         if (is_array($customDataType)) {
 469           $value = NULL;
 470           foreach ($customDataType as $dataType) {
 471             if (in_array($dataType, array_keys(CRM_Core_SelectValues::customGroupExtends()))) {
 472               if (in_array($dataType, array('Individual', 'Household', 'Organization'))) {
 473                 $val = "'" . CRM_Utils_Type::escape($dataType, 'String') . "', 'Contact' ";
 474               }
 475               else {
 476                 $val = "'" . CRM_Utils_Type::escape($dataType, 'String') . "'";
 477               }
 478               $value = $value ? $value . ", {$val}" : $val;
 479             }
 480           }
 481           if ($value) {
 482             $extends = "AND   $cgTable.extends IN ( $value ) ";
 483           }
 484         }
 485
 486         if (!empty($customDataType) && empty($extends)) {
 487           // $customDataType specified a filter, but there is no corresponding SQL ($extends)
 488           self::$_importFields[$cacheKey] = array();
 489           return self::$_importFields[$cacheKey];
 490         }
 491
 492         if ($onlyParent) {
 493           $extends .= " AND $cgTable.extends_entity_column_value IS NULL AND $cgTable.extends_entity_column_id IS NULL ";
 494         }
 495
 496         $query = "SELECT $cfTable.id, $cfTable.label,
 497                             $cgTable.title,
 498                             $cfTable.data_type,
 499                             $cfTable.html_type,
 500                             $cfTable.default_value,
 501                             $cfTable.options_per_line, $cfTable.text_length,
 502                             $cfTable.custom_group_id,
 503                             $cfTable.is_required,
 504                             $cgTable.extends, $cfTable.is_search_range,
 505                             $cgTable.extends_entity_column_value,
 506                             $cgTable.extends_entity_column_id,
 507                             $cfTable.is_view,
 508                             $cfTable.option_group_id,
 509                             $cfTable.date_format,
 510                             $cfTable.time_format,
 511                             $cgTable.is_multiple,
 512                             og.name as option_group_name
 513                      FROM $cfTable
 514                      INNER JOIN $cgTable
 515                        ON $cfTable.custom_group_id = $cgTable.id
 516                      LEFT JOIN civicrm_option_group og
 517                        ON $cfTable.option_group_id = og.id
 518                      WHERE ( 1 ) ";
 519
 520         if (!$showAll) {
 521           $query .= " AND $cfTable.is_active = 1 AND $cgTable.is_active = 1 ";
 522         }
 523
 524         if ($inline) {
 525           $query .= " AND $cgTable.style = 'Inline' ";
 526         }
 527
 528         //get the custom fields for specific type in
 529         //combination with fields those support any type.
 530         if (!empty($customDataSubType)) {
 531           $subtypeClause = array();
 532           foreach ($customDataSubType as $subtype) {
 533             $subtype = CRM_Core_DAO::VALUE_SEPARATOR . $subtype . CRM_Core_DAO::VALUE_SEPARATOR;
 534             $subtypeClause[] = "$cgTable.extends_entity_column_value LIKE '%{$subtype}%'";
 535           }
 536           if (!$onlySubType) {
 537             $subtypeClause[] = "$cgTable.extends_entity_column_value IS NULL";
 538           }
 539           $query .= " AND ( " . implode(' OR ', $subtypeClause) . " )";
 540         }
 541
 542         if ($customDataSubName) {
 543           $query .= " AND ( $cgTable.extends_entity_column_id = $customDataSubName ) ";
 544         }
 545
 546         // also get the permission stuff here
 547         if ($checkPermission) {
 548           $permissionClause = CRM_Core_Permission::customGroupClause(CRM_Core_Permission::VIEW,
 549             "{$cgTable}.", TRUE
 550           );
 551         }
 552         else {
 553           $permissionClause = '(1)';
 554         }
 555
 556         $query .= " $extends AND $permissionClause
 557                         ORDER BY $cgTable.weight, $cgTable.title,
 558                                  $cfTable.weight, $cfTable.label";
 559
 560         $dao = CRM_Core_DAO::executeQuery($query);
 561
 562         $fields = array();
 563         while (($dao->fetch()) != NULL) {
 564           $fields[$dao->id]['label'] = $dao->label;
 565           $fields[$dao->id]['groupTitle'] = $dao->title;
 566           $fields[$dao->id]['data_type'] = $dao->data_type;
 567           $fields[$dao->id]['html_type'] = $dao->html_type;
 568           $fields[$dao->id]['default_value'] = $dao->default_value;
 569           $fields[$dao->id]['text_length'] = $dao->text_length;
 570           $fields[$dao->id]['options_per_line'] = $dao->options_per_line;
 571           $fields[$dao->id]['custom_group_id'] = $dao->custom_group_id;
 572           $fields[$dao->id]['extends'] = $dao->extends;
 573           $fields[$dao->id]['is_search_range'] = $dao->is_search_range;
 574           $fields[$dao->id]['extends_entity_column_value'] = $dao->extends_entity_column_value;
 575           $fields[$dao->id]['extends_entity_column_id'] = $dao->extends_entity_column_id;
 576           $fields[$dao->id]['is_view'] = $dao->is_view;
 577           $fields[$dao->id]['is_multiple'] = $dao->is_multiple;
 578           $fields[$dao->id]['option_group_id'] = $dao->option_group_id;
 579           $fields[$dao->id]['date_format'] = $dao->date_format;
 580           $fields[$dao->id]['time_format'] = $dao->time_format;
 581           $fields[$dao->id]['is_required'] = $dao->is_required;
 582           self::getOptionsForField($fields[$dao->id], $dao->option_group_name);
 583         }
 584
 585         CRM_Core_BAO_Cache::setItem($fields,
 586           'contact fields',
 587           "custom importableFields $cacheKey"
 588         );
 589       }
 590       self::$_importFields[$cacheKey] = $fields;
 591     }
 592
 593     return self::$_importFields[$cacheKey];
 594   }
 595
 596   /**
 597    * Return the field ids and names (with groups) for import purpose.
 598    *
 599    * @param int|string $contactType Contact type
 600    * @param bool $showAll
 601    *   If true returns all fields (includes disabled fields).
 602    * @param bool $onlyParent
 603    *   Return fields ONLY related to basic types.
 604    * @param bool $search
 605    *   When called from search and multiple records need to be returned.
 606    * @param bool $checkPermission
 607    *   If false, do not include permissioning clause.
 608    *
 609    * @param bool $withMultiple
 610    *
 611    * @return array
 612    */
 613   public static function getFieldsForImport(
 614     $contactType = 'Individual',
 615     $showAll = FALSE,
 616     $onlyParent = FALSE,
 617     $search = FALSE,
 618     $checkPermission = TRUE,
 619     $withMultiple = FALSE
 620   ) {
 621     // Note: there are situations when we want getFieldsForImport() return fields related
 622     // ONLY to basic contact types, but NOT subtypes. And thats where $onlyParent is helpful
 623     $fields = &self::getFields($contactType,
 624       $showAll,
 625       FALSE,
 626       NULL,
 627       NULL,
 628       $onlyParent,
 629       FALSE,
 630       $checkPermission
 631     );
 632
 633     $importableFields = array();
 634     foreach ($fields as $id => $values) {
 635       // for now we should not allow multiple fields in profile / export etc, hence unsetting
 636       if (!$search &&
 637         (!empty($values['is_multiple']) && !$withMultiple)
 638       ) {
 639         continue;
 640       }
 641
 642       /* generate the key for the fields array */
 643
 644       $key = "custom_$id";
 645
 646       $regexp = preg_replace('/[.,;:!?]/', '', CRM_Utils_Array::value(0, $values));
 647       $importableFields[$key] = array(
 648         'name' => $key,
 649         'title' => CRM_Utils_Array::value('label', $values),
 650         'headerPattern' => '/' . preg_quote($regexp, '/') . '/',
 651         'import' => 1,
 652         'custom_field_id' => $id,
 653         'options_per_line' => CRM_Utils_Array::value('options_per_line', $values),
 654         'text_length' => CRM_Utils_Array::value('text_length', $values, 255),
 655         'data_type' => CRM_Utils_Array::value('data_type', $values),
 656         'html_type' => CRM_Utils_Array::value('html_type', $values),
 657         'is_search_range' => CRM_Utils_Array::value('is_search_range', $values),
 658       );
 659
 660       // CRM-6681, pass date and time format when html_type = Select Date
 661       if (CRM_Utils_Array::value('html_type', $values) == 'Select Date') {
 662         $importableFields[$key]['date_format'] = CRM_Utils_Array::value('date_format', $values);
 663         $importableFields[$key]['time_format'] = CRM_Utils_Array::value('time_format', $values);
 664       }
 665     }
 666
 667     return $importableFields;
 668   }
 669
 670   /**
 671    * Get the field id from an import key.
 672    *
 673    * @param string $key
 674    *   The key to parse.
 675    *
 676    * @param bool $all
 677    *
 678    * @return int|null
 679    *   The id (if exists)
 680    */
 681   public static function getKeyID($key, $all = FALSE) {
 682     $match = array();
 683     if (preg_match('/^custom_(\d+)_?(-?\d+)?$/', $key, $match)) {
 684       if (!$all) {
 685         return $match[1];
 686       }
 687       else {
 688         return array(
 689           $match[1],
 690           CRM_Utils_Array::value(2, $match),
 691         );
 692       }
 693     }
 694     return $all ? array(NULL, NULL) : NULL;
 695   }
 696
 697   /**
 698    * Use the cache to get all values of a specific custom field.
 699    *
 700    * @param int $fieldID
 701    *   The custom field ID.
 702    *
 703    * @return CRM_Core_DAO_CustomField
 704    *   The field object.
 705    */
 706   public static function getFieldObject($fieldID) {
 707     $field = new CRM_Core_DAO_CustomField();
 708
 709     // check if we can get the field values from the system cache
 710     $cacheKey = "CRM_Core_DAO_CustomField_{$fieldID}";
 711     $cache = CRM_Utils_Cache::singleton();
 712     $fieldValues = $cache->get($cacheKey);
 713     if (empty($fieldValues)) {
 714       $field->id = $fieldID;
 715       if (!$field->find(TRUE)) {
 716         CRM_Core_Error::fatal();
 717       }
 718
 719       $fieldValues = array();
 720       CRM_Core_DAO::storeValues($field, $fieldValues);
 721
 722       $cache->set($cacheKey, $fieldValues);
 723     }
 724     else {
 725       $field->copyValues($fieldValues);
 726     }
 727
 728     return $field;
 729   }
 730
 731   /**
 732    * This function for building custom fields.
 733    *
 734    * @param CRM_Core_Form $qf
 735    *   Form object (reference).
 736    * @param string $elementName
 737    *   Name of the custom field.
 738    * @param int $fieldId
 739    * @param bool $inactiveNeeded
 740    *   -deprecated.
 741    * @param bool $useRequired
 742    *   True if required else false.
 743    * @param bool $search
 744    *   True if used for search else false.
 745    * @param string $label
 746    *   Label for custom field.
 747    */
 748   public static function addQuickFormElement(
 749     &$qf,
 750     $elementName,
 751     $fieldId,
 752     $inactiveNeeded = FALSE,
 753     $useRequired = TRUE,
 754     $search = FALSE,
 755     $label = NULL
 756   ) {
 757     $field = self::getFieldObject($fieldId);
 758     $widget = $field->html_type;
 759
 760     // Custom field HTML should indicate group+field name
 761     $groupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $field->custom_group_id);
 762     $dataCrmCustomVal = $groupName . ':' . $field->name;
 763     $dataCrmCustomAttr = 'data-crm-custom="' . $dataCrmCustomVal . '"';
 764     $field->attributes .= $dataCrmCustomAttr;
 765
 766     // Fixed for Issue CRM-2183
 767     if ($widget == 'TextArea' && $search) {
 768       $widget = 'Text';
 769     }
 770
 771     $placeholder = $search ? ts('- any -') : ($useRequired ? ts('- select -') : ts('- none -'));
 772
 773     // FIXME: Why are select state/country separate widget types?
 774     $isSelect = (in_array($widget, array(
 775       'Select',
 776       'Multi-Select',
 777       'Select State/Province',
 778       'Multi-Select State/Province',
 779       'Select Country',
 780       'Multi-Select Country',
 781       'AdvMulti-Select',
 782       'CheckBox',
 783       'Radio',
 784     )));
 785
 786     if ($isSelect) {
 787       $options = CRM_Utils_Array::value('values', civicrm_api3('contact', 'getoptions', array(
 788         'field' => "custom_$fieldId",
 789         'context' => $search ? 'search' : 'create',
 790       ), array()));
 791
 792       // Consolidate widget types to simplify the below switch statement
 793       if ($search || ($widget !== 'AdvMulti-Select' && strpos($widget, 'Select') !== FALSE)) {
 794         $widget = 'Select';
 795       }
 796       $selectAttributes = array(
 797         'data-crm-custom' => $dataCrmCustomVal,
 798         'class' => 'crm-select2',
 799       );
 800       // Search field is always multi-select
 801       if ($search || strpos($field->html_type, 'Multi') !== FALSE) {
 802         $selectAttributes['class'] .= ' huge';
 803         $selectAttributes['multiple'] = 'multiple';
 804         $selectAttributes['placeholder'] = $placeholder;
 805       }
 806       // Add data for popup link. Normally this is handled by CRM_Core_Form->addSelect
 807       if ($field->option_group_id && !$search && $widget == 'Select' && CRM_Core_Permission::check('administer CiviCRM')) {
 808         $selectAttributes += array(
 809           'data-api-entity' => 'contact',
 810           // FIXME: This works because the getoptions api isn't picky about custom fields, but it's WRONG
 811           'data-api-field' => 'custom_' . $field->id,
 812           'data-option-edit-path' => 'civicrm/admin/options/' . CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $field->option_group_id),
 813         );
 814       }
 815     }
 816
 817     if (!isset($label)) {
 818       $label = $field->label;
 819     }
 820
 821     // at some point in time we might want to split the below into small functions
 822
 823     switch ($widget) {
 824       case 'Text':
 825       case 'Link':
 826         if ($field->is_search_range && $search) {
 827           $qf->add('text', $elementName . '_from', $label . ' ' . ts('From'), $field->attributes);
 828           $qf->add('text', $elementName . '_to', ts('To'), $field->attributes);
 829         }
 830         else {
 831           $element = &$qf->add('text', $elementName, $label,
 832             $field->attributes,
 833             $useRequired && !$search
 834           );
 835         }
 836         break;
 837
 838       case 'TextArea':
 839         $attributes = $dataCrmCustomAttr;
 840         if ($field->note_rows) {
 841           $attributes .= 'rows=' . $field->note_rows;
 842         }
 843         else {
 844           $attributes .= 'rows=4';
 845         }
 846         if ($field->note_columns) {
 847           $attributes .= ' cols=' . $field->note_columns;
 848         }
 849         else {
 850           $attributes .= ' cols=60';
 851         }
 852         if ($field->text_length) {
 853           $attributes .= ' maxlength=' . $field->text_length;
 854         }
 855         $element = &$qf->add('textarea',
 856           $elementName,
 857           $label,
 858           $attributes,
 859           $useRequired && !$search
 860         );
 861         break;
 862
 863       case 'Select Date':
 864         if ($field->is_search_range && $search) {
 865           $qf->addDate($elementName . '_from', $label . ' - ' . ts('From'), FALSE,
 866             array(
 867               'format' => $field->date_format,
 868               'timeFormat' => $field->time_format,
 869               'startOffset' => $field->start_date_years,
 870               'endOffset' => $field->end_date_years,
 871               'data-crm-custom' => $dataCrmCustomVal,
 872             )
 873           );
 874
 875           $qf->addDate($elementName . '_to', ts('To'), FALSE,
 876             array(
 877               'format' => $field->date_format,
 878               'timeFormat' => $field->time_format,
 879               'startOffset' => $field->start_date_years,
 880               'endOffset' => $field->end_date_years,
 881               'data-crm-custom' => $dataCrmCustomVal,
 882             )
 883           );
 884         }
 885         else {
 886           $required = $useRequired && !$search;
 887
 888           $qf->addDate($elementName, $label, $required, array(
 889             'format' => $field->date_format,
 890             'timeFormat' => $field->time_format,
 891             'startOffset' => $field->start_date_years,
 892             'endOffset' => $field->end_date_years,
 893             'data-crm-custom' => $dataCrmCustomVal,
 894           ));
 895         }
 896         break;
 897
 898       case 'Radio':
 899         $choice = array();
 900         foreach ($options as $v => $l) {
 901           $choice[] = $qf->createElement('radio', NULL, '', $l, (string) $v, $field->attributes);
 902         }
 903         $group = $qf->addGroup($choice, $elementName, $label);
 904         if ($useRequired && !$search) {
 905           $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
 906         }
 907         else {
 908           $group->setAttribute('allowClear', TRUE);
 909         }
 910         break;
 911
 912       // For all select elements
 913       case 'Select':
 914         if (empty($selectAttributes['multiple'])) {
 915           $options = array('' => $placeholder) + $options;
 916         }
 917         $qf->add('select', $elementName, $label, $options, $useRequired && !$search, $selectAttributes);
 918
 919         // Add and/or option for fields that store multiple values
 920         if ($search && self::isSerialized($field)) {
 921
 922           $operators = array(
 923             $qf->createElement('radio', NULL, '', ts('Any'), 'or', array('title' => ts('Results may contain any of the selected options'))),
 924             $qf->createElement('radio', NULL, '', ts('All'), 'and', array('title' => ts('Results must have all of the selected options'))),
 925           );
 926           $qf->addGroup($operators, $elementName . '_operator');
 927           $qf->setDefaults(array($elementName . '_operator' => 'or'));
 928         }
 929         break;
 930
 931       case 'AdvMulti-Select':
 932         $include =& $qf->addElement(
 933           'advmultiselect',
 934           $elementName,
 935           $label, $options,
 936           array(
 937             'size' => 5,
 938             'style' => '',
 939             'class' => 'advmultiselect',
 940             'data-crm-custom' => $dataCrmCustomVal,
 941           )
 942         );
 943
 944         $include->setButtonAttributes('add', array('value' => ts('Add >>')));
 945         $include->setButtonAttributes('remove', array('value' => ts('<< Remove')));
 946
 947         if ($useRequired && !$search) {
 948           $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
 949         }
 950         break;
 951
 952       case 'CheckBox':
 953         $check = array();
 954         foreach ($options as $v => $l) {
 955           $check[] = &$qf->addElement('advcheckbox', $v, NULL, $l, array('data-crm-custom' => $dataCrmCustomVal));
 956         }
 957         $qf->addGroup($check, $elementName, $label);
 958         if ($useRequired && !$search) {
 959           $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
 960         }
 961         break;
 962
 963       case 'File':
 964         // we should not build upload file in search mode
 965         if ($search) {
 966           return;
 967         }
 968         $qf->add(
 969           strtolower($field->html_type),
 970           $elementName,
 971           $label,
 972           $field->attributes,
 973           $useRequired && !$search
 974         );
 975         $qf->addUploadElement($elementName);
 976         break;
 977
 978       case 'RichTextEditor':
 979         $attributes = array(
 980           'rows' => $field->note_rows,
 981           'cols' => $field->note_columns,
 982           'data-crm-custom' => $dataCrmCustomVal,
 983         );
 984         if ($field->text_length) {
 985           $attributes['maxlength'] = $field->text_length;
 986         }
 987         $qf->add('wysiwyg', $elementName, $label, $attributes, $search);
 988         break;
 989
 990       case 'Autocomplete-Select':
 991         static $customUrls = array();
 992         // Fixme: why is this a string in the first place??
 993         $attributes = array();
 994         if ($field->attributes) {
 995           foreach (explode(' ', $field->attributes) as $at) {
 996             if (strpos($at, '=')) {
 997               list($k, $v) = explode('=', $at);
 998               $attributes[$k] = trim($v, ' "');
 999             }
1000           }
1001         }
1002         if ($field->data_type == 'ContactReference') {
1003           $attributes['class'] = (isset($attributes['class']) ? $attributes['class'] . ' ' : '') . 'crm-form-contact-reference huge';
1004           $attributes['data-api-entity'] = 'contact';
1005           $qf->add('text', $elementName, $label, $attributes,
1006             $useRequired && !$search
1007           );
1008
1009           $urlParams = "context=customfield&id={$field->id}";
1010
1011           $customUrls[$elementName] = CRM_Utils_System::url('civicrm/ajax/contactref',
1012             $urlParams,
1013             FALSE, NULL, FALSE
1014           );
1015
1016         }
1017         else {
1018           // FIXME: This won't work with customFieldOptions hook
1019           $attributes += array(
1020             'entity' => 'option_value',
1021             'placeholder' => $placeholder,
1022             'multiple' => $search,
1023             'api' => array(
1024               'params' => array('option_group_id' => $field->option_group_id),
1025             ),
1026           );
1027           $qf->addEntityRef($elementName, $label, $attributes, $useRequired && !$search);
1028         }
1029
1030         $qf->assign('customUrls', $customUrls);
1031         break;
1032     }
1033
1034     switch ($field->data_type) {
1035       case 'Int':
1036         // integers will have numeric rule applied to them.
1037         if ($field->is_search_range && $search) {
1038           $qf->addRule($elementName . '_from', ts('%1 From must be an integer (whole number).', array(1 => $label)), 'integer');
1039           $qf->addRule($elementName . '_to', ts('%1 To must be an integer (whole number).', array(1 => $label)), 'integer');
1040         }
1041         elseif ($widget == 'Text') {
1042           $qf->addRule($elementName, ts('%1 must be an integer (whole number).', array(1 => $label)), 'integer');
1043         }
1044         break;
1045
1046       case 'Float':
1047         if ($field->is_search_range && $search) {
1048           $qf->addRule($elementName . '_from', ts('%1 From must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1049           $qf->addRule($elementName . '_to', ts('%1 To must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1050         }
1051         elseif ($widget == 'Text') {
1052           $qf->addRule($elementName, ts('%1 must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1053         }
1054         break;
1055
1056       case 'Money':
1057         if ($field->is_search_range && $search) {
1058           $qf->addRule($elementName . '_from', ts('%1 From must in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1059           $qf->addRule($elementName . '_to', ts('%1 To must in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1060         }
1061         elseif ($widget == 'Text') {
1062           $qf->addRule($elementName, ts('%1 must be in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1063         }
1064         break;
1065
1066       case 'Link':
1067         $element->setAttribute('class', "url");
1068         $qf->addRule($elementName, ts('Enter a valid web address beginning with \'http://\' or \'https://\'.'), 'wikiURL');
1069         break;
1070     }
1071     if ($field->is_view && !$search) {
1072       $qf->freeze($elementName);
1073     }
1074   }
1075
1076   /**
1077    * Delete the Custom Field.
1078    *
1079    * @param object $field
1080    *   The field object.
1081    */
1082   public static function deleteField($field) {
1083     CRM_Utils_System::flushCache();
1084
1085     // first delete the custom option group and values associated with this field
1086     if ($field->option_group_id) {
1087       //check if option group is related to any other field, if
1088       //not delete the option group and related option values
1089       self::checkOptionGroup($field->option_group_id);
1090     }
1091
1092     // next drop the column from the custom value table
1093     self::createField($field, 'delete');
1094
1095     $field->delete();
1096     CRM_Core_BAO_UFField::delUFField($field->id);
1097     CRM_Utils_Weight::correctDuplicateWeights('CRM_Core_DAO_CustomField');
1098   }
1099
1100   /**
1101    * Find the display value for this field.
1102    *
1103    * @param mixed $value
1104    *   The custom field value.
1105    * @param int $id
1106    *   The custom field id.
1107    * @param array $options
1108    *   The assoc array of option name/value pairs.
1109    *
1110    * @param int $contactID
1111    * @param int $fieldID
1112    *
1113    * @return string
1114    *   the display value
1115    */
1116   public static function getDisplayValue($value, $id, &$options, $contactID = NULL, $fieldID = NULL) {
1117     $option = &$options[$id];
1118     $attributes = &$option['attributes'];
1119     $html_type = $attributes['html_type'];
1120     $data_type = $attributes['data_type'];
1121
1122     return self::getDisplayValueCommon($value,
1123       $option,
1124       $html_type,
1125       $data_type,
1126       $contactID,
1127       $fieldID
1128     );
1129   }
1130
1131   /**
1132    * Get display value.
1133    *
1134    * @param string $value
1135    * @param array $option
1136    * @param string $html_type
1137    * @param string $data_type
1138    * @param int $contactID
1139    * @param int $fieldID
1140    *
1141    * @return array|mixed|null|string
1142    */
1143   public static function getDisplayValueCommon(
1144     $value,
1145     &$option,
1146     $html_type,
1147     $data_type,
1148     $contactID = NULL,
1149     $fieldID = NULL
1150   ) {
1151     $display = $value;
1152
1153     if ($fieldID &&
1154       (($html_type == 'Radio' && $data_type != 'Boolean') ||
1155         ($html_type == 'Autocomplete-Select' && $data_type != 'ContactReference') ||
1156         $html_type == 'Select' ||
1157         $html_type == 'CheckBox' ||
1158         $html_type == 'AdvMulti-Select' ||
1159         $html_type == 'Multi-Select'
1160       )
1161     ) {
1162       CRM_Utils_Hook::customFieldOptions($fieldID, $option);
1163     }
1164
1165     switch ($html_type) {
1166       case 'Radio':
1167         if ($data_type == 'Boolean') {
1168           $options = array('No', 'Yes');
1169         }
1170         else {
1171           $options = $option;
1172         }
1173         if (is_array($value)) {
1174           $display = NULL;
1175           foreach ($value as $data) {
1176             $display .= $display ? ', ' . $options[$data] : $options[$data];
1177           }
1178         }
1179         else {
1180           $display = CRM_Utils_Array::value($value, $options);
1181         }
1182         break;
1183
1184       case 'Autocomplete-Select':
1185         if ($data_type == 'ContactReference' &&
1186           $value
1187         ) {
1188           $display = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'display_name');
1189         }
1190         elseif (is_array($value)) {
1191           $display = NULL;
1192           foreach ($value as $data) {
1193             $display .= $display ? ', ' . $option[$data] : $option[$data];
1194           }
1195         }
1196         else {
1197           $display = CRM_Utils_Array::value($value, $option);
1198         }
1199         break;
1200
1201       case 'Select':
1202         if (is_array($value)) {
1203           $display = NULL;
1204           foreach ($value as $data) {
1205             $display .= $display ? ', ' . $option[$data] : $option[$data];
1206           }
1207         }
1208         else {
1209           $display = CRM_Utils_Array::value($value, $option);
1210         }
1211         break;
1212
1213       case 'CheckBox':
1214       case 'AdvMulti-Select':
1215       case 'Multi-Select':
1216         if (is_array($value)) {
1217           $checkedData = $value;
1218         }
1219         else {
1220           $checkedData = explode(CRM_Core_DAO::VALUE_SEPARATOR,
1221             substr($value, 1, -1)
1222           );
1223           if ($html_type == 'CheckBox') {
1224             $newData = array();
1225             foreach ($checkedData as $v) {
1226               $v = str_replace(CRM_Core_DAO::VALUE_SEPARATOR, '', $v);
1227               $newData[] = $v;
1228             }
1229             $checkedData = $newData;
1230           }
1231         }
1232
1233         $v = array();
1234         foreach ($checkedData as $key => $val) {
1235           $v[] = CRM_Utils_Array::value($val, $option);
1236         }
1237         if (!empty($v)) {
1238           $display = implode(', ', $v);
1239         }
1240         break;
1241
1242       case 'Select Date':
1243         if (is_array($value)) {
1244           foreach ($value as $key => $val) {
1245             $display[$key] = CRM_Utils_Date::customFormat($val);
1246           }
1247         }
1248         else {
1249           // remove time element display if time is not set
1250           if (empty($option['attributes']['time_format'])) {
1251             $value = substr($value, 0, 10);
1252           }
1253           $display = CRM_Utils_Date::customFormat($value);
1254         }
1255         break;
1256
1257       case 'Select State/Province':
1258       case 'Multi-Select State/Province':
1259       case 'Select Country':
1260       case 'Multi-Select Country':
1261         if (strstr($html_type, 'State/Province')) {
1262           $option = CRM_Core_PseudoConstant::stateProvince(FALSE, FALSE);
1263         }
1264         else {
1265           $option = CRM_Core_PseudoConstant::country(FALSE, FALSE);
1266         }
1267         // process multi-select state/country field values
1268         if (!is_array($value)) {
1269           $value = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
1270         }
1271
1272         $display = NULL;
1273         foreach ($value as $data) {
1274           $display .= ($display && !empty($option[$data])) ? ', ' . $option[$data] : $option[$data];
1275         }
1276         break;
1277
1278       case 'File':
1279         // In the context of displaying a profile, show file/image
1280         if ($contactID && $value) {
1281           $url = self::getFileURL($contactID, $fieldID, $value);
1282           if ($url) {
1283             $display = $url['file_url'];
1284           }
1285         }
1286         // In other contexts show a paperclip icon
1287         elseif ($value) {
1288           $icons = CRM_Core_BAO_File::paperIconAttachment('*', $value);
1289           $display = $icons[$value];
1290         }
1291         break;
1292
1293       case 'TextArea':
1294         if (empty($value)) {
1295           $display = '';
1296         }
1297         else {
1298           $display = is_array($value) ? nl2br(implode(', ', $value)) : nl2br($value);
1299         }
1300         break;
1301
1302       case 'Link':
1303       case 'Text':
1304         if (empty($value)) {
1305           $display = '';
1306         }
1307         else {
1308           $display = is_array($value) ? implode(', ', $value) : $value;
1309         }
1310     }
1311     return $display ? $display : $value;
1312   }
1313
1314   /**
1315    * Set default values for custom data used in profile.
1316    *
1317    * @param int $customFieldId
1318    *   Custom field id.
1319    * @param string $elementName
1320    *   Custom field name.
1321    * @param array $defaults
1322    *   Associated array of fields.
1323    * @param int $contactId
1324    *   Contact id.
1325    * @param int $mode
1326    *   Profile mode.
1327    * @param mixed $value
1328    *   If passed - dont fetch value from db,.
1329    *                               just format the given value
1330    */
1331   public static function setProfileDefaults(
1332     $customFieldId,
1333     $elementName,
1334     &$defaults,
1335     $contactId = NULL,
1336     $mode = NULL,
1337     $value = NULL
1338   ) {
1339     //get the type of custom field
1340     $customField = new CRM_Core_BAO_CustomField();
1341     $customField->id = $customFieldId;
1342     $customField->find(TRUE);
1343
1344     if (!$contactId) {
1345       if ($mode == CRM_Profile_Form::MODE_CREATE) {
1346         $value = $customField->default_value;
1347       }
1348     }
1349     else {
1350       if (!isset($value)) {
1351         $info = self::getTableColumnGroup($customFieldId);
1352         $query = "SELECT {$info[0]}.{$info[1]} as value FROM {$info[0]} WHERE {$info[0]}.entity_id = {$contactId}";
1353         $result = CRM_Core_DAO::executeQuery($query);
1354         if ($result->fetch()) {
1355           $value = $result->value;
1356         }
1357       }
1358
1359       if ($customField->data_type == 'Country') {
1360         if (!$value) {
1361           $config = CRM_Core_Config::singleton();
1362           if ($config->defaultContactCountry) {
1363             $value = $config->defaultContactCountry();
1364           }
1365         }
1366       }
1367     }
1368
1369     //set defaults if mode is registration
1370     if (!trim($value) &&
1371       ($value !== 0) &&
1372       (!in_array($mode, array(CRM_Profile_Form::MODE_EDIT, CRM_Profile_Form::MODE_SEARCH)))
1373     ) {
1374       $value = $customField->default_value;
1375     }
1376
1377     if ($customField->data_type == 'Money' && isset($value)) {
1378       $value = number_format($value, 2);
1379     }
1380     switch ($customField->html_type) {
1381       case 'CheckBox':
1382       case 'AdvMulti-Select':
1383       case 'Multi-Select':
1384         $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldId, FALSE);
1385         $defaults[$elementName] = array();
1386         $checkedValue = explode(CRM_Core_DAO::VALUE_SEPARATOR,
1387           substr($value, 1, -1)
1388         );
1389         foreach ($customOption as $val) {
1390           if (in_array($val['value'], $checkedValue)) {
1391             if ($customField->html_type == 'CheckBox') {
1392               $defaults[$elementName][$val['value']] = 1;
1393             }
1394             elseif ($customField->html_type == 'Multi-Select' ||
1395               $customField->html_type == 'AdvMulti-Select'
1396             ) {
1397               $defaults[$elementName][$val['value']] = $val['value'];
1398             }
1399           }
1400         }
1401         break;
1402
1403       case 'Select Date':
1404         if ($value) {
1405           list($defaults[$elementName], $defaults[$elementName . '_time']) = CRM_Utils_Date::setDateDefaults(
1406             $value,
1407             NULL,
1408             $customField->date_format,
1409             $customField->time_format
1410           );
1411         }
1412         break;
1413
1414       case 'Autocomplete-Select':
1415         if ($customField->data_type == 'ContactReference') {
1416           if (is_numeric($value)) {
1417             $defaults[$elementName . '_id'] = $value;
1418             $defaults[$elementName] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'sort_name');
1419           }
1420         }
1421         else {
1422           $defaults[$elementName] = $value;
1423         }
1424         break;
1425
1426       default:
1427         $defaults[$elementName] = $value;
1428     }
1429   }
1430
1431   /**
1432    * Get file url.
1433    *
1434    * @param int $contactID
1435    * @param int $cfID
1436    * @param int $fileID
1437    * @param bool $absolute
1438    *
1439    * @return array
1440    */
1441   public static function getFileURL($contactID, $cfID, $fileID = NULL, $absolute = FALSE, $multiRecordWhereClause = NULL) {
1442     if ($contactID) {
1443       if (!$fileID) {
1444         $params = array('id' => $cfID);
1445         $defaults = array();
1446         CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
1447         $columnName = $defaults['column_name'];
1448
1449         //table name of custom data
1450         $tableName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup',
1451           $defaults['custom_group_id'],
1452           'table_name', 'id'
1453         );
1454
1455         //query to fetch id from civicrm_file
1456         if ($multiRecordWhereClause) {
1457           $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID} AND {$multiRecordWhereClause}";
1458         }
1459         else {
1460           $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID}";
1461         }
1462         $fileID = CRM_Core_DAO::singleValueQuery($query);
1463       }
1464
1465       $result = array();
1466       if ($fileID) {
1467         $fileType = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_File',
1468           $fileID,
1469           'mime_type',
1470           'id'
1471         );
1472         $result['file_id'] = $fileID;
1473
1474         if ($fileType == 'image/jpeg' ||
1475           $fileType == 'image/pjpeg' ||
1476           $fileType == 'image/gif' ||
1477           $fileType == 'image/x-png' ||
1478           $fileType == 'image/png'
1479         ) {
1480           $entityId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_EntityFile',
1481             $fileID,
1482             'entity_id',
1483             'id'
1484           );
1485           list($path) = CRM_Core_BAO_File::path($fileID, $entityId, NULL, NULL);
1486           list($imageWidth, $imageHeight) = getimagesize($path);
1487           list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact::getThumbSize($imageWidth, $imageHeight);
1488           $url = CRM_Utils_System::url('civicrm/file',
1489             "reset=1&id=$fileID&eid=$contactID",
1490             $absolute, NULL, TRUE, TRUE
1491           );
1492           $result['file_url'] = "
1493           <a href=\"$url\" class='crm-image-popup'>
1494           <img src=\"$url\" width=$imageThumbWidth height=$imageThumbHeight/>
1495           </a>";
1496           // for non image files
1497         }
1498         else {
1499           $uri = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_File',
1500             $fileID,
1501             'uri'
1502           );
1503           $url = CRM_Utils_System::url('civicrm/file',
1504             "reset=1&id=$fileID&eid=$contactID",
1505             $absolute, NULL, TRUE, TRUE
1506           );
1507           $result['file_url'] = "<a href=\"$url\">{$uri}</a>";
1508         }
1509       }
1510       return $result;
1511     }
1512   }
1513
1514   /**
1515    * Format custom fields before inserting.
1516    *
1517    * @param int $customFieldId
1518    *   Custom field id.
1519    * @param array $customFormatted
1520    *   Formatted array.
1521    * @param mixed $value
1522    *   Value of custom field.
1523    * @param string $customFieldExtend
1524    *   Custom field extends.
1525    * @param int $customValueId
1526    *   Custom option value id.
1527    * @param int $entityId
1528    *   Entity id (contribution, membership...).
1529    * @param bool $inline
1530    *   Consider inline custom groups only.
1531    * @param bool $checkPermission
1532    *   If false, do not include permissioning clause.
1533    * @param bool $includeViewOnly
1534    *   If true, fields marked 'View Only' are included. Required for APIv3.
1535    *
1536    * @return array|NULL
1537    *   formatted custom field array
1538    */
1539   public static function formatCustomField(
1540     $customFieldId, &$customFormatted, $value,
1541     $customFieldExtend, $customValueId = NULL,
1542     $entityId = NULL,
1543     $inline = FALSE,
1544     $checkPermission = TRUE,
1545     $includeViewOnly = FALSE
1546   ) {
1547     //get the custom fields for the entity
1548     //subtype and basic type
1549     $customDataSubType = NULL;
1550     if ($customFieldExtend) {
1551       // This is the case when getFieldsForImport() requires fields
1552       // of subtype and its parent.CRM-5143
1553       // CRM-16065 - Custom field set data not being saved if contact has more than one contact sub type
1554       $customDataSubType = array_intersect(CRM_Contact_BAO_ContactType::subTypes(), (array) $customFieldExtend);
1555       if (!empty($customDataSubType) && is_array($customDataSubType)) {
1556         $customFieldExtend = CRM_Contact_BAO_ContactType::getBasicType($customDataSubType);
1557         if (is_array($customFieldExtend)) {
1558           $customFieldExtend = array_unique(array_values($customFieldExtend));
1559         }
1560       }
1561     }
1562
1563     $customFields = CRM_Core_BAO_CustomField::getFields($customFieldExtend,
1564       FALSE,
1565       $inline,
1566       $customDataSubType,
1567       NULL,
1568       FALSE,
1569       FALSE,
1570       $checkPermission
1571     );
1572
1573     if (!array_key_exists($customFieldId, $customFields)) {
1574       return NULL;
1575     }
1576
1577     // return if field is a 'code' field
1578     if (!$includeViewOnly && !empty($customFields[$customFieldId]['is_view'])) {
1579       return NULL;
1580     }
1581
1582     list($tableName, $columnName, $groupID) = self::getTableColumnGroup($customFieldId);
1583
1584     if (!$customValueId &&
1585       // we always create new entites for is_multiple unless specified
1586       !$customFields[$customFieldId]['is_multiple'] &&
1587       $entityId
1588     ) {
1589       $query = "
1590 SELECT id
1591   FROM $tableName
1592  WHERE entity_id={$entityId}";
1593
1594       $customValueId = CRM_Core_DAO::singleValueQuery($query);
1595     }
1596
1597     //fix checkbox, now check box always submits values
1598     if ($customFields[$customFieldId]['html_type'] == 'CheckBox') {
1599       if ($value) {
1600         // Note that only during merge this is not an array, and you can directly use value
1601         if (is_array($value)) {
1602           $selectedValues = array();
1603           foreach ($value as $selId => $val) {
1604             if ($val) {
1605               $selectedValues[] = $selId;
1606             }
1607           }
1608           if (!empty($selectedValues)) {
1609             $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
1610                 $selectedValues
1611               ) . CRM_Core_DAO::VALUE_SEPARATOR;
1612           }
1613           else {
1614             $value = '';
1615           }
1616         }
1617       }
1618     }
1619
1620     if ($customFields[$customFieldId]['html_type'] == 'Multi-Select' ||
1621       $customFields[$customFieldId]['html_type'] == 'AdvMulti-Select'
1622     ) {
1623       if ($value) {
1624         // Note that only during merge this is not an array,
1625         // and you can directly use value, CRM-4385
1626         if (is_array($value)) {
1627           $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR,
1628               array_values($value)
1629             ) . CRM_Core_DAO::VALUE_SEPARATOR;
1630         }
1631       }
1632       else {
1633         $value = '';
1634       }
1635     }
1636
1637     if (($customFields[$customFieldId]['html_type'] == 'Multi-Select' ||
1638         $customFields[$customFieldId]['html_type'] == 'AdvMulti-Select' ||
1639         $customFields[$customFieldId]['html_type'] == 'CheckBox'
1640       ) &&
1641       $customFields[$customFieldId]['data_type'] == 'String' &&
1642       !empty($customFields[$customFieldId]['text_length']) &&
1643       !empty($value)
1644     ) {
1645       // lets make sure that value is less than the length, else we'll
1646       // be losing some data, CRM-7481
1647       if (strlen($value) >= $customFields[$customFieldId]['text_length']) {
1648         // need to do a few things here
1649
1650         // 1. lets find a new length
1651         $newLength = $customFields[$customFieldId]['text_length'];
1652         $minLength = strlen($value);
1653         while ($newLength < $minLength) {
1654           $newLength = $newLength * 2;
1655         }
1656
1657         // set the custom field meta data to have a length larger than value
1658         // alter the custom value table column to match this length
1659         CRM_Core_BAO_SchemaHandler::alterFieldLength($customFieldId, $tableName, $columnName, $newLength);
1660       }
1661     }
1662
1663     $date = NULL;
1664     if ($customFields[$customFieldId]['data_type'] == 'Date') {
1665       if (!CRM_Utils_System::isNull($value)) {
1666         $format = $customFields[$customFieldId]['date_format'];
1667         $date = CRM_Utils_Date::processDate($value, NULL, FALSE, 'YmdHis', $format);
1668       }
1669       $value = $date;
1670     }
1671
1672     if ($customFields[$customFieldId]['data_type'] == 'Float' ||
1673       $customFields[$customFieldId]['data_type'] == 'Money'
1674     ) {
1675       if (!$value) {
1676         $value = 0;
1677       }
1678
1679       if ($customFields[$customFieldId]['data_type'] == 'Money') {
1680         $value = CRM_Utils_Rule::cleanMoney($value);
1681       }
1682     }
1683
1684     if (($customFields[$customFieldId]['data_type'] == 'StateProvince' ||
1685         $customFields[$customFieldId]['data_type'] == 'Country'
1686       ) &&
1687       empty($value)
1688     ) {
1689       // CRM-3415
1690       $value = 0;
1691     }
1692
1693     $fileId = NULL;
1694
1695     if ($customFields[$customFieldId]['data_type'] == 'File') {
1696       if (empty($value)) {
1697         return;
1698       }
1699
1700       $config = CRM_Core_Config::singleton();
1701
1702       $fName = $value['name'];
1703       $mimeType = $value['type'];
1704
1705       $filename = pathinfo($fName, PATHINFO_BASENAME);
1706
1707       // rename this file to go into the secure directory
1708       if (!rename($fName, $config->customFileUploadDir . $filename)) {
1709         CRM_Core_Error::statusBounce(ts('Could not move custom file to custom upload directory'));
1710       }
1711
1712       if ($customValueId) {
1713         $query = "
1714 SELECT $columnName
1715   FROM $tableName
1716  WHERE id = %1";
1717         $params = array(1 => array($customValueId, 'Integer'));
1718         $fileId = CRM_Core_DAO::singleValueQuery($query, $params);
1719       }
1720
1721       $fileDAO = new CRM_Core_DAO_File();
1722
1723       if ($fileId) {
1724         $fileDAO->id = $fileId;
1725       }
1726
1727       $fileDAO->uri = $filename;
1728       $fileDAO->mime_type = $mimeType;
1729       $fileDAO->upload_date = date('Ymdhis');
1730       $fileDAO->save();
1731       $fileId = $fileDAO->id;
1732       $value = $filename;
1733     }
1734
1735     if (!is_array($customFormatted)) {
1736       $customFormatted = array();
1737     }
1738
1739     if (!array_key_exists($customFieldId, $customFormatted)) {
1740       $customFormatted[$customFieldId] = array();
1741     }
1742
1743     $index = -1;
1744     if ($customValueId) {
1745       $index = $customValueId;
1746     }
1747
1748     if (!array_key_exists($index, $customFormatted[$customFieldId])) {
1749       $customFormatted[$customFieldId][$index] = array();
1750     }
1751     $customFormatted[$customFieldId][$index] = array(
1752       'id' => $customValueId > 0 ? $customValueId : NULL,
1753       'value' => $value,
1754       'type' => $customFields[$customFieldId]['data_type'],
1755       'custom_field_id' => $customFieldId,
1756       'custom_group_id' => $groupID,
1757       'table_name' => $tableName,
1758       'column_name' => $columnName,
1759       'file_id' => $fileId,
1760       'is_multiple' => $customFields[$customFieldId]['is_multiple'],
1761     );
1762
1763     //we need to sort so that custom fields are created in the order of entry
1764     krsort($customFormatted[$customFieldId]);
1765     return $customFormatted;
1766   }
1767
1768   /**
1769    * Get default custom table schema.
1770    *
1771    * @param array $params
1772    *
1773    * @return array
1774    */
1775   public static function defaultCustomTableSchema($params) {
1776     // add the id and extends_id
1777     $table = array(
1778       'name' => $params['name'],
1779       'is_multiple' => $params['is_multiple'],
1780       'attributes' => "ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci",
1781       'fields' => array(
1782         array(
1783           'name' => 'id',
1784           'type' => 'int unsigned',
1785           'primary' => TRUE,
1786           'required' => TRUE,
1787           'attributes' => 'AUTO_INCREMENT',
1788           'comment' => 'Default MySQL primary key',
1789         ),
1790         array(
1791           'name' => 'entity_id',
1792           'type' => 'int unsigned',
1793           'required' => TRUE,
1794           'comment' => 'Table that this extends',
1795           'fk_table_name' => $params['extends_name'],
1796           'fk_field_name' => 'id',
1797           'fk_attributes' => 'ON DELETE CASCADE',
1798         ),
1799       ),
1800     );
1801
1802     if (!$params['is_multiple']) {
1803       $table['indexes'] = array(
1804         array(
1805           'unique' => TRUE,
1806           'field_name_1' => 'entity_id',
1807         ),
1808       );
1809     }
1810     return $table;
1811   }
1812
1813   /**
1814    * Create custom field.
1815    *
1816    * @param CRM_Core_DAO_CustomField $field
1817    * @param string $operation
1818    * @param bool $indexExist
1819    * @param bool $triggerRebuild
1820    */
1821   public static function createField($field, $operation, $indexExist = FALSE, $triggerRebuild = TRUE) {
1822     $tableName = CRM_Core_DAO::getFieldValue(
1823       'CRM_Core_DAO_CustomGroup',
1824       $field->custom_group_id,
1825       'table_name'
1826     );
1827
1828     $params = array(
1829       'table_name' => $tableName,
1830       'operation' => $operation,
1831       'name' => $field->column_name,
1832       'type' => CRM_Core_BAO_CustomValueTable::fieldToSQLType(
1833         $field->data_type,
1834         $field->text_length
1835       ),
1836       'required' => $field->is_required,
1837       'searchable' => $field->is_searchable,
1838     );
1839
1840     if ($operation == 'delete') {
1841       $fkName = "{$tableName}_{$field->column_name}";
1842       if (strlen($fkName) >= 48) {
1843         $fkName = substr($fkName, 0, 32) . '_' . substr(md5($fkName), 0, 16);
1844       }
1845       $params['fkName'] = $fkName;
1846     }
1847     if ($field->data_type == 'Country' && $field->html_type == 'Select Country') {
1848       $params['fk_table_name'] = 'civicrm_country';
1849       $params['fk_field_name'] = 'id';
1850       $params['fk_attributes'] = 'ON DELETE SET NULL';
1851     }
1852     elseif ($field->data_type == 'Country' && $field->html_type == 'Multi-Select Country') {
1853       $params['type'] = 'varchar(255)';
1854     }
1855     elseif ($field->data_type == 'StateProvince' && $field->html_type == 'Select State/Province') {
1856       $params['fk_table_name'] = 'civicrm_state_province';
1857       $params['fk_field_name'] = 'id';
1858       $params['fk_attributes'] = 'ON DELETE SET NULL';
1859     }
1860     elseif ($field->data_type == 'StateProvince' && $field->html_type == 'Multi-Select State/Province') {
1861       $params['type'] = 'varchar(255)';
1862     }
1863     elseif ($field->data_type == 'File') {
1864       $params['fk_table_name'] = 'civicrm_file';
1865       $params['fk_field_name'] = 'id';
1866       $params['fk_attributes'] = 'ON DELETE SET NULL';
1867     }
1868     elseif ($field->data_type == 'ContactReference') {
1869       $params['fk_table_name'] = 'civicrm_contact';
1870       $params['fk_field_name'] = 'id';
1871       $params['fk_attributes'] = 'ON DELETE SET NULL';
1872     }
1873     if (isset($field->default_value)) {
1874       $params['default'] = "'{$field->default_value}'";
1875     }
1876
1877     CRM_Core_BAO_SchemaHandler::alterFieldSQL($params, $indexExist, $triggerRebuild);
1878   }
1879
1880   /**
1881    * Determine whether it would be safe to move a field.
1882    *
1883    * @param int $fieldID
1884    *   FK to civicrm_custom_field.
1885    * @param int $newGroupID
1886    *   FK to civicrm_custom_group.
1887    *
1888    * @return array
1889    *   array(string) or TRUE
1890    */
1891   public static function _moveFieldValidate($fieldID, $newGroupID) {
1892     $errors = array();
1893
1894     $field = new CRM_Core_DAO_CustomField();
1895     $field->id = $fieldID;
1896     if (!$field->find(TRUE)) {
1897       $errors['fieldID'] = 'Invalid ID for custom field';
1898       return $errors;
1899     }
1900
1901     $oldGroup = new CRM_Core_DAO_CustomGroup();
1902     $oldGroup->id = $field->custom_group_id;
1903     if (!$oldGroup->find(TRUE)) {
1904       $errors['fieldID'] = 'Invalid ID for old custom group';
1905       return $errors;
1906     }
1907
1908     $newGroup = new CRM_Core_DAO_CustomGroup();
1909     $newGroup->id = $newGroupID;
1910     if (!$newGroup->find(TRUE)) {
1911       $errors['newGroupID'] = 'Invalid ID for new custom group';
1912       return $errors;
1913     }
1914
1915     $query = "
1916 SELECT     b.id
1917 FROM       civicrm_custom_field a
1918 INNER JOIN civicrm_custom_field b
1919 WHERE      a.id = %1
1920 AND        a.label = b.label
1921 AND        b.custom_group_id = %2
1922 ";
1923     $params = array(
1924       1 => array($field->id, 'Integer'),
1925       2 => array($newGroup->id, 'Integer'),
1926     );
1927     $count = CRM_Core_DAO::singleValueQuery($query, $params);
1928     if ($count > 0) {
1929       $errors['newGroupID'] = ts('A field of the same label exists in the destination group');
1930     }
1931
1932     $tableName = $oldGroup->table_name;
1933     $columnName = $field->column_name;
1934
1935     $query = "
1936 SELECT count(*)
1937 FROM   $tableName
1938 WHERE  $columnName is not null
1939 ";
1940     $count = CRM_Core_DAO::singleValueQuery($query,
1941       CRM_Core_DAO::$_nullArray
1942     );
1943     if ($count > 0) {
1944       $query = "
1945 SELECT extends
1946 FROM   civicrm_custom_group
1947 WHERE  id IN ( %1, %2 )
1948 ";
1949       $params = array(
1950         1 => array($oldGroup->id, 'Integer'),
1951         2 => array($newGroup->id, 'Integer'),
1952       );
1953
1954       $dao = CRM_Core_DAO::executeQuery($query, $params);
1955       $extends = array();
1956       while ($dao->fetch()) {
1957         $extends[] = $dao->extends;
1958       }
1959       if ($extends[0] != $extends[1]) {
1960         $errors['newGroupID'] = ts('The destination group extends a different entity type.');
1961       }
1962     }
1963
1964     return empty($errors) ? TRUE : $errors;
1965   }
1966
1967   /**
1968    * Move a custom data field from one group (table) to another.
1969    *
1970    * @param int $fieldID
1971    *   FK to civicrm_custom_field.
1972    * @param int $newGroupID
1973    *   FK to civicrm_custom_group.
1974    */
1975   public static function moveField($fieldID, $newGroupID) {
1976     $validation = self::_moveFieldValidate($fieldID, $newGroupID);
1977     if (TRUE !== $validation) {
1978       CRM_Core_Error::fatal(implode(' ', $validation));
1979     }
1980     $field = new CRM_Core_DAO_CustomField();
1981     $field->id = $fieldID;
1982     $field->find(TRUE);
1983
1984     $newGroup = new CRM_Core_DAO_CustomGroup();
1985     $newGroup->id = $newGroupID;
1986     $newGroup->find(TRUE);
1987
1988     $oldGroup = new CRM_Core_DAO_CustomGroup();
1989     $oldGroup->id = $field->custom_group_id;
1990     $oldGroup->find(TRUE);
1991
1992     $add = clone$field;
1993     $add->custom_group_id = $newGroup->id;
1994     self::createField($add, 'add');
1995
1996     $sql = "INSERT INTO {$newGroup->table_name} (entity_id, {$field->column_name})
1997             SELECT entity_id, {$field->column_name} FROM {$oldGroup->table_name}
1998             ON DUPLICATE KEY UPDATE {$field->column_name} = {$oldGroup->table_name}.{$field->column_name}
1999             ";
2000     CRM_Core_DAO::executeQuery($sql);
2001
2002     $del = clone$field;
2003     $del->custom_group_id = $oldGroup->id;
2004     self::createField($del, 'delete');
2005
2006     $add->save();
2007
2008     CRM_Utils_System::flushCache();
2009   }
2010
2011   /**
2012    * Get the database table name and column name for a custom field.
2013    *
2014    * @param int $fieldID
2015    *   The fieldID of the custom field.
2016    * @param bool $force
2017    *   Force the sql to be run again (primarily used for tests).
2018    *
2019    * @return array
2020    *   fatal is fieldID does not exists, else array of tableName, columnName
2021    */
2022   public static function getTableColumnGroup($fieldID, $force = FALSE) {
2023     $cacheKey = "CRM_Core_DAO_CustomField_CustomGroup_TableColumn_{$fieldID}";
2024     $cache = CRM_Utils_Cache::singleton();
2025     $fieldValues = $cache->get($cacheKey);
2026     if (empty($fieldValues) || $force) {
2027       $query = "
2028 SELECT cg.table_name, cf.column_name, cg.id
2029 FROM   civicrm_custom_group cg,
2030        civicrm_custom_field cf
2031 WHERE  cf.custom_group_id = cg.id
2032 AND    cf.id = %1";
2033       $params = array(1 => array($fieldID, 'Integer'));
2034       $dao = CRM_Core_DAO::executeQuery($query, $params);
2035
2036       if (!$dao->fetch()) {
2037         CRM_Core_Error::fatal();
2038       }
2039       $dao->free();
2040       $fieldValues = array($dao->table_name, $dao->column_name, $dao->id);
2041       $cache->set($cacheKey, $fieldValues);
2042     }
2043     return $fieldValues;
2044   }
2045
2046   /**
2047    * Get custom option groups.
2048    *
2049    * @param array $includeFieldIds
2050    *   Ids of custom fields for which option groups must be included.
2051    *
2052    * Currently this is required in the cases where option groups are to be included
2053    * for inactive fields : CRM-5369
2054    *
2055    * @return mixed
2056    */
2057   public static function customOptionGroup($includeFieldIds = NULL) {
2058     static $customOptionGroup = NULL;
2059
2060     $cacheKey = (empty($includeFieldIds)) ? 'onlyActive' : 'force';
2061     if ($cacheKey == 'force') {
2062       $customOptionGroup[$cacheKey] = NULL;
2063     }
2064
2065     if (empty($customOptionGroup[$cacheKey])) {
2066       $whereClause = '( g.is_active = 1 AND f.is_active = 1 )';
2067
2068       //support for single as well as array format.
2069       if (!empty($includeFieldIds)) {
2070         if (is_array($includeFieldIds)) {
2071           $includeFieldIds = implode(',', $includeFieldIds);
2072         }
2073         $whereClause .= "OR f.id IN ( $includeFieldIds )";
2074       }
2075
2076       $query = "
2077     SELECT  g.id, g.title
2078       FROM  civicrm_option_group g
2079 INNER JOIN  civicrm_custom_field f ON ( g.id = f.option_group_id )
2080      WHERE  {$whereClause}";
2081
2082       $dao = CRM_Core_DAO::executeQuery($query);
2083       while ($dao->fetch()) {
2084         $customOptionGroup[$cacheKey][$dao->id] = $dao->title;
2085       }
2086     }
2087
2088     return $customOptionGroup[$cacheKey];
2089   }
2090
2091   /**
2092    * Fix orphan groups.
2093    *
2094    * @param int $customFieldId
2095    *   Custom field id.
2096    * @param int $optionGroupId
2097    *   Option group id.
2098    */
2099   public static function fixOptionGroups($customFieldId, $optionGroupId) {
2100     // check if option group belongs to any custom Field else delete
2101     // get the current option group
2102     $currentOptionGroupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
2103       $customFieldId,
2104       'option_group_id'
2105     );
2106     // get the updated option group
2107     // if both are same return
2108     if ($currentOptionGroupId == $optionGroupId) {
2109       return;
2110     }
2111
2112     // check if option group is related to any other field
2113     self::checkOptionGroup($currentOptionGroupId);
2114   }
2115
2116   /**
2117    * Check if option group is related to more than one custom field.
2118    *
2119    * @param int $optionGroupId
2120    *   Option group id.
2121    */
2122   public static function checkOptionGroup($optionGroupId) {
2123     $query = "
2124 SELECT count(*)
2125 FROM   civicrm_custom_field
2126 WHERE  option_group_id = {$optionGroupId}";
2127
2128     $count = CRM_Core_DAO::singleValueQuery($query);
2129
2130     if ($count < 2) {
2131       //delete the option group
2132       CRM_Core_BAO_OptionGroup::del($optionGroupId);
2133     }
2134   }
2135
2136   /**
2137    * Get option group default.
2138    *
2139    * @param int $optionGroupId
2140    * @param string $htmlType
2141    *
2142    * @return null|string
2143    */
2144   public static function getOptionGroupDefault($optionGroupId, $htmlType) {
2145     $query = "
2146 SELECT   default_value, html_type
2147 FROM     civicrm_custom_field
2148 WHERE    option_group_id = {$optionGroupId}
2149 AND      default_value IS NOT NULL
2150 ORDER BY html_type";
2151
2152     $dao = CRM_Core_DAO::executeQuery($query);
2153     $defaultValue = NULL;
2154     $defaultHTMLType = NULL;
2155     while ($dao->fetch()) {
2156       if ($dao->html_type == $htmlType) {
2157         return $dao->default_value;
2158       }
2159       if ($defaultValue == NULL) {
2160         $defaultValue = $dao->default_value;
2161         $defaultHTMLType = $dao->html_type;
2162       }
2163     }
2164
2165     // some conversions are needed if either the old or new has a html type which has potential
2166     // multiple default values.
2167     if (($htmlType == 'CheckBox' || $htmlType == 'Multi-Select') &&
2168       ($defaultHTMLType != 'CheckBox' && $defaultHTMLType != 'Multi-Select')
2169     ) {
2170       $defaultValue = CRM_Core_DAO::VALUE_SEPARATOR . $defaultValue . CRM_Core_DAO::VALUE_SEPARATOR;
2171     }
2172     elseif (($defaultHTMLType == 'CheckBox' || $defaultHTMLType == 'Multi-Select') &&
2173       ($htmlType != 'CheckBox' && $htmlType != 'Multi-Select')
2174     ) {
2175       $defaultValue = substr($defaultValue, 1, -1);
2176       $values = explode(CRM_Core_DAO::VALUE_SEPARATOR,
2177         substr($defaultValue, 1, -1)
2178       );
2179       $defaultValue = $values[0];
2180     }
2181
2182     return $defaultValue;
2183   }
2184
2185   /**
2186    * Post process function.
2187    *
2188    * @param array $params
2189    * @param int $entityID
2190    * @param string $customFieldExtends
2191    * @param bool $inline
2192    *
2193    * @return array
2194    */
2195   public static function postProcess(
2196     &$params,
2197     $entityID,
2198     $customFieldExtends,
2199     $inline = FALSE
2200   ) {
2201     $customData = array();
2202
2203     foreach ($params as $key => $value) {
2204       if ($customFieldInfo = CRM_Core_BAO_CustomField::getKeyID($key, TRUE)) {
2205
2206         // for autocomplete transfer hidden value instead of label
2207         if ($params[$key] && isset($params[$key . '_id'])) {
2208           $value = $params[$key . '_id'];
2209         }
2210
2211         // we need to append time with date
2212         if ($params[$key] && isset($params[$key . '_time'])) {
2213           $value .= ' ' . $params[$key . '_time'];
2214         }
2215
2216         CRM_Core_BAO_CustomField::formatCustomField($customFieldInfo[0],
2217           $customData,
2218           $value,
2219           $customFieldExtends,
2220           $customFieldInfo[1],
2221           $entityID,
2222           $inline
2223         );
2224       }
2225     }
2226     return $customData;
2227   }
2228
2229   /**
2230    * Build option.
2231    *
2232    * @param array $field
2233    * @param array $options
2234    *
2235    * @throws Exception
2236    */
2237   public static function buildOption($field, &$options) {
2238     // Fixme - adding anything but options to the $options array is a bad idea
2239     // What if an option had the key 'attributes'?
2240     $options['attributes'] = array(
2241       'label' => $field['label'],
2242       'data_type' => $field['data_type'],
2243       'html_type' => $field['html_type'],
2244     );
2245
2246     $optionGroupID = NULL;
2247     if (($field['html_type'] == 'CheckBox' ||
2248       $field['html_type'] == 'Radio' ||
2249       $field['html_type'] == 'Select' ||
2250       $field['html_type'] == 'AdvMulti-Select' ||
2251       $field['html_type'] == 'Multi-Select' ||
2252       ($field['html_type'] == 'Autocomplete-Select' && $field['data_type'] != 'ContactReference')
2253     )
2254     ) {
2255       if ($field['option_group_id']) {
2256         $optionGroupID = $field['option_group_id'];
2257       }
2258       elseif ($field['data_type'] != 'Boolean') {
2259         CRM_Core_Error::fatal();
2260       }
2261     }
2262
2263     // build the cache for custom values with options (label => value)
2264     if ($optionGroupID != NULL) {
2265       $query = "
2266 SELECT label, value
2267   FROM civicrm_option_value
2268  WHERE option_group_id = $optionGroupID
2269 ";
2270
2271       $dao = CRM_Core_DAO::executeQuery($query);
2272       while ($dao->fetch()) {
2273         if ($field['data_type'] == 'Int' || $field['data_type'] == 'Float') {
2274           $num = round($dao->value, 2);
2275           $options["$num"] = $dao->label;
2276         }
2277         else {
2278           $options[$dao->value] = $dao->label;
2279         }
2280       }
2281
2282       CRM_Utils_Hook::customFieldOptions($field['id'], $options);
2283     }
2284   }
2285
2286   /**
2287    * Get custom field ID.
2288    *
2289    * @param string $fieldLabel
2290    * @param null $groupTitle
2291    *
2292    * @return int|null
2293    */
2294   public static function getCustomFieldID($fieldLabel, $groupTitle = NULL) {
2295     $params = array(1 => array($fieldLabel, 'String'));
2296     if ($groupTitle) {
2297       $params[2] = array($groupTitle, 'String');
2298       $sql = "
2299 SELECT     f.id
2300 FROM       civicrm_custom_field f
2301 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
2302 WHERE      ( f.label = %1 OR f.name  = %1 )
2303 AND        ( g.title = %2 OR g.name = %2 )
2304 ";
2305     }
2306     else {
2307       $sql = "
2308 SELECT     f.id
2309 FROM       civicrm_custom_field f
2310 WHERE      ( f.label = %1 OR f.name = %1 )
2311 ";
2312     }
2313
2314     $dao = CRM_Core_DAO::executeQuery($sql, $params);
2315     if ($dao->fetch() &&
2316       $dao->N == 1
2317     ) {
2318       return $dao->id;
2319     }
2320     else {
2321       return NULL;
2322     }
2323   }
2324
2325   /**
2326    * Given ID of a custom field, return its name as well as the name of the custom group it belongs to.
2327    *
2328    * @param array $ids
2329    *
2330    * @return array
2331    */
2332   public static function getNameFromID($ids) {
2333     if (is_array($ids)) {
2334       $ids = implode(',', $ids);
2335     }
2336     $sql = "
2337 SELECT     f.id, f.name AS field_name, f.label AS field_label, g.name AS group_name, g.title AS group_title
2338 FROM       civicrm_custom_field f
2339 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
2340 WHERE      f.id IN ($ids)";
2341
2342     $dao = CRM_Core_DAO::executeQuery($sql);
2343     $result = array();
2344     while ($dao->fetch()) {
2345       $result[$dao->id] = array(
2346         'field_name' => $dao->field_name,
2347         'field_label' => $dao->field_label,
2348         'group_name' => $dao->group_name,
2349         'group_title' => $dao->group_title,
2350       );
2351     }
2352     return $result;
2353   }
2354
2355   /**
2356    * Validate custom data.
2357    *
2358    * @param array $params
2359    *   Custom data submitted.
2360    *   ie array( 'custom_1' => 'validate me' );
2361    *
2362    * @return array
2363    *   validation errors.
2364    */
2365   public static function validateCustomData($params) {
2366     $errors = array();
2367     if (!is_array($params) || empty($params)) {
2368       return $errors;
2369     }
2370
2371     //pick up profile fields.
2372     $profileFields = array();
2373     $ufGroupId = CRM_Utils_Array::value('ufGroupId', $params);
2374     if ($ufGroupId) {
2375       $profileFields = CRM_Core_BAO_UFGroup::getFields($ufGroupId,
2376         FALSE,
2377         CRM_Core_Action::VIEW
2378       );
2379     }
2380
2381     //lets start w/ params.
2382     foreach ($params as $key => $value) {
2383       $customFieldID = self::getKeyID($key);
2384       if (!$customFieldID) {
2385         continue;
2386       }
2387
2388       //load the structural info for given field.
2389       $field = new CRM_Core_DAO_CustomField();
2390       $field->id = $customFieldID;
2391       if (!$field->find(TRUE)) {
2392         continue;
2393       }
2394       $dataType = $field->data_type;
2395
2396       $profileField = CRM_Utils_Array::value($key, $profileFields, array());
2397       $fieldTitle = CRM_Utils_Array::value('title', $profileField);
2398       $isRequired = CRM_Utils_Array::value('is_required', $profileField);
2399       if (!$fieldTitle) {
2400         $fieldTitle = $field->label;
2401       }
2402
2403       //no need to validate.
2404       if (CRM_Utils_System::isNull($value) && !$isRequired) {
2405         continue;
2406       }
2407
2408       //lets validate first for required field.
2409       if ($isRequired && CRM_Utils_System::isNull($value)) {
2410         $errors[$key] = ts('%1 is a required field.', array(1 => $fieldTitle));
2411         continue;
2412       }
2413
2414       //now time to take care of custom field form rules.
2415       $ruleName = $errorMsg = NULL;
2416       switch ($dataType) {
2417         case 'Int':
2418           $ruleName = 'integer';
2419           $errorMsg = ts('%1 must be an integer (whole number).',
2420             array(1 => $fieldTitle)
2421           );
2422           break;
2423
2424         case 'Money':
2425           $ruleName = 'money';
2426           $errorMsg = ts('%1 must in proper money format. (decimal point/comma/space is allowed).',
2427             array(1 => $fieldTitle)
2428           );
2429           break;
2430
2431         case 'Float':
2432           $ruleName = 'numeric';
2433           $errorMsg = ts('%1 must be a number (with or without decimal point).',
2434             array(1 => $fieldTitle)
2435           );
2436           break;
2437
2438         case 'Link':
2439           $ruleName = 'wikiURL';
2440           $errorMsg = ts('%1 must be valid Website.',
2441             array(1 => $fieldTitle)
2442           );
2443           break;
2444       }
2445
2446       if ($ruleName && !CRM_Utils_System::isNull($value)) {
2447         $valid = FALSE;
2448         $funName = "CRM_Utils_Rule::{$ruleName}";
2449         if (is_callable($funName)) {
2450           $valid = call_user_func($funName, $value);
2451         }
2452         if (!$valid) {
2453           $errors[$key] = $errorMsg;
2454         }
2455       }
2456     }
2457
2458     return $errors;
2459   }
2460
2461   /**
2462    * Is this field a multi record field.
2463    *
2464    * @param int $customId
2465    *
2466    * @return bool
2467    */
2468   public static function isMultiRecordField($customId) {
2469     $isMultipleWithGid = FALSE;
2470     if (!is_numeric($customId)) {
2471       $customId = self::getKeyID($customId);
2472     }
2473     if (is_numeric($customId)) {
2474       $sql = "SELECT cg.id cgId
2475  FROM civicrm_custom_group cg
2476  INNER JOIN civicrm_custom_field cf
2477  ON cg.id = cf.custom_group_id
2478 WHERE cf.id = %1 AND cg.is_multiple = 1";
2479       $params[1] = array($customId, 'Integer');
2480       $dao = CRM_Core_DAO::executeQuery($sql, $params);
2481       if ($dao->fetch()) {
2482         if ($dao->cgId) {
2483           $isMultipleWithGid = $dao->cgId;
2484         }
2485       }
2486     }
2487
2488     return $isMultipleWithGid;
2489   }
2490
2491   /**
2492    * Does this field store a serialized string?
2493    *
2494    * @param array $field
2495    *
2496    * @return bool
2497    */
2498   public static function isSerialized($field) {
2499     // Fields retrieved via api are an array, or from the dao are an object. We'll accept either.
2500     $field = (array) $field;
2501     // FIXME: Currently the only way to know if data is serialized is by looking at the html_type. It would be cleaner to decouple this.
2502     return ($field['html_type'] == 'CheckBox' || strpos($field['html_type'], 'Multi') !== FALSE);
2503   }
2504
2505   /**
2506    * Get options for field.
2507    *
2508    * @param array $field
2509    * @param string|null $optionGroupName
2510    */
2511   private static function getOptionsForField(&$field, $optionGroupName) {
2512     if ($optionGroupName) {
2513       $field['pseudoconstant'] = array(
2514         'optionGroupName' => $optionGroupName,
2515         'optionEditPath' => 'civicrm/admin/options/' . $optionGroupName,
2516       );
2517     }
2518     elseif ($field['data_type'] == 'Boolean') {
2519       $field['pseudoconstant'] = array(
2520         'callback' => 'CRM_Core_SelectValues::boolean',
2521       );
2522     }
2523     elseif ($field['data_type'] == 'Country') {
2524       $field['pseudoconstant'] = array(
2525         'table' => 'civicrm_country',
2526         'keyColumn' => 'id',
2527         'labelColumn' => 'name',
2528         'nameColumn' => 'iso_code',
2529       );
2530     }
2531     elseif ($field['data_type'] == 'StateProvince') {
2532       $field['pseudoconstant'] = array(
2533         'table' => 'civicrm_state_province',
2534         'keyColumn' => 'id',
2535         'labelColumn' => 'name',
2536       );
2537     }
2538   }
2539
2540 }