CRM/Core/BAO/CustomField.php

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