CRM/Profile/Form.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  *
  33  */
  34
  35 /**
  36  * This class generates form components for custom data
  37  *
  38  * It delegates the work to lower level subclasses and integrates the changes
  39  * back in. It also uses a lot of functionality with the CRM API's, so any change
  40  * made here could potentially affect the API etc. Be careful, be aware, use unit tests.
  41  *
  42  */
  43 class CRM_Profile_Form extends CRM_Core_Form {
  44   const
  45     MODE_REGISTER = 1,
  46     MODE_SEARCH = 2,
  47     MODE_CREATE = 4,
  48     MODE_EDIT = 8;
  49
  50   protected $_mode;
  51
  52   protected $_skipPermission = FALSE;
  53
  54   /**
  55    * The contact id that we are editing.
  56    *
  57    * @var int
  58    */
  59   protected $_id;
  60
  61   /**
  62    * The group id that we are editing.
  63    *
  64    * @var int
  65    */
  66   protected $_gid;
  67
  68   /**
  69    * @var array details of the UFGroup used on this page
  70    */
  71   protected $_ufGroup = ['name' => 'unknown'];
  72
  73   /**
  74    * The group id that we are passing in url.
  75    *
  76    * @var int
  77    */
  78   public $_grid;
  79
  80   /**
  81    * Name of button for saving matching contacts.
  82    * @var string
  83    */
  84   protected $_duplicateButtonName;
  85   /**
  86    * The title of the category we are editing.
  87    *
  88    * @var string
  89    */
  90   protected $_title;
  91
  92   /**
  93    * The fields needed to build this form.
  94    *
  95    * @var array
  96    */
  97   public $_fields;
  98
  99   /**
 100    * store contact details.
 101    *
 102    * @var array
 103    */
 104   protected $_contact;
 105
 106   /**
 107    * Do we allow updates of the contact.
 108    *
 109    * @var int
 110    */
 111   public $_isUpdateDupe = 0;
 112
 113   /**
 114    * Dedupe using a specific rule (CRM-6131).
 115    * Not currently exposed in profile settings, but can be set in a buildForm hook.
 116    * @var int
 117    */
 118   public $_ruleGroupID = NULL;
 119
 120   public $_isAddCaptcha = FALSE;
 121
 122   protected $_isPermissionedChecksum = FALSE;
 123
 124   /**
 125    * THe context from which we came from, allows us to go there if redirect not set.
 126    *
 127    * @var string
 128    */
 129   protected $_context;
 130
 131   /**
 132    * THe contact type for registration case.
 133    *
 134    * @var string
 135    */
 136   protected $_ctype = NULL;
 137
 138   /**
 139    * Store profile ids if multiple profile ids are passed using comma separated.
 140    * Currently lets implement this functionality only for dialog mode.
 141    * @var array
 142    */
 143   protected $_profileIds = [];
 144
 145   /**
 146    * Contact profile having activity fields?
 147    *
 148    * @var string
 149    */
 150   protected $_isContactActivityProfile = FALSE;
 151
 152   /**
 153    * Activity Id connected to the profile.
 154    *
 155    * @var string
 156    */
 157   protected $_activityId = NULL;
 158
 159
 160   protected $_multiRecordFields = NULL;
 161
 162   protected $_recordId = NULL;
 163
 164   /**
 165    * Action for multi record profile (create/edit/delete).
 166    *
 167    * @var string
 168    */
 169   protected $_multiRecord = NULL;
 170
 171   protected $_multiRecordProfile = FALSE;
 172
 173   protected $_recordExists = TRUE;
 174
 175   protected $_customGroupTitle = NULL;
 176
 177   protected $_deleteButtonName = NULL;
 178
 179   protected $_customGroupId = NULL;
 180
 181   protected $_currentUserID = NULL;
 182   protected $_session = NULL;
 183
 184   /**
 185    * Check for any duplicates.
 186    *
 187    * Depending on form settings & usage scenario we potentially use the found id,
 188    * create links to found ids or add an error.
 189    *
 190    * @param array $errors
 191    * @param array $fields
 192    * @param CRM_Profile_Form $form
 193    *
 194    * @return array
 195    */
 196   protected static function handleDuplicateChecking(&$errors, $fields, $form) {
 197     if ($form->_mode == CRM_Profile_Form::MODE_CREATE) {
 198       // fix for CRM-2888
 199       $exceptions = [];
 200     }
 201     else {
 202       // for edit mode we need to allow our own record to be a dupe match!
 203       $exceptions = [$form->_session->get('userID')];
 204     }
 205     $contactType = CRM_Core_BAO_UFGroup::getContactType($form->_gid);
 206     // If all profile fields is of Contact Type then consider
 207     // profile is of Individual type(default).
 208     if (!$contactType) {
 209       $contactType = 'Individual';
 210     }
 211
 212     $ids = CRM_Contact_BAO_Contact::getDuplicateContacts(
 213       $fields, $contactType,
 214       ($form->_context === 'dialog' ? 'Supervised' : 'Unsupervised'),
 215       $exceptions,
 216       FALSE,
 217       $form->_ruleGroupID
 218     );
 219     if ($ids) {
 220       if ($form->_isUpdateDupe == 2) {
 221         CRM_Core_Session::setStatus(ts('Note: this contact may be a duplicate of an existing record.'), ts('Possible Duplicate Detected'), 'alert');
 222       }
 223       elseif ($form->_isUpdateDupe == 1) {
 224         $form->_id = $ids[0];
 225       }
 226       else {
 227         if ($form->_context == 'dialog') {
 228           $contactLinks = CRM_Contact_BAO_Contact_Utils::formatContactIDSToLinks($ids, TRUE, TRUE);
 229
 230           $duplicateContactsLinks = '<div class="matching-contacts-found">';
 231           $duplicateContactsLinks .= ts('One matching contact was found. ', [
 232             'count' => count($contactLinks['rows']),
 233             'plural' => '%count matching contacts were found.<br />',
 234           ]);
 235           if ($contactLinks['msg'] == 'view') {
 236             $duplicateContactsLinks .= ts('You can View the existing contact.', [
 237               'count' => count($contactLinks['rows']),
 238               'plural' => 'You can View the existing contacts.',
 239             ]);
 240           }
 241           else {
 242             $duplicateContactsLinks .= ts('You can View or Edit the existing contact.', [
 243               'count' => count($contactLinks['rows']),
 244               'plural' => 'You can View or Edit the existing contacts.',
 245             ]);
 246           }
 247           $duplicateContactsLinks .= '</div>';
 248           $duplicateContactsLinks .= '<table class="matching-contacts-actions">';
 249           $row = '';
 250           for ($i = 0; $i < count($contactLinks['rows']); $i++) {
 251             $row .= '  <tr>   ';
 252             $row .= '    <td class="matching-contacts-name"> ';
 253             $row .= $contactLinks['rows'][$i]['display_name'];
 254             $row .= '    </td>';
 255             $row .= '    <td class="matching-contacts-email"> ';
 256             $row .= $contactLinks['rows'][$i]['primary_email'];
 257             $row .= '    </td>';
 258             $row .= '    <td class="action-items"> ';
 259             $row .= $contactLinks['rows'][$i]['view'] . ' ';
 260             $row .= $contactLinks['rows'][$i]['edit'];
 261             $row .= '    </td>';
 262             $row .= '  </tr>   ';
 263           }
 264
 265           $duplicateContactsLinks .= $row . '</table>';
 266           $duplicateContactsLinks .= "If you're sure this record is not a duplicate, click the 'Save Matching Contact' button below.";
 267
 268           $errors['_qf_default'] = $duplicateContactsLinks;
 269
 270           // let smarty know that there are duplicates
 271           $template = CRM_Core_Smarty::singleton();
 272           $template->assign('isDuplicate', 1);
 273         }
 274         else {
 275           $errors['_qf_default'] = ts('A record already exists with the same information.');
 276         }
 277       }
 278     }
 279     return $errors;
 280   }
 281
 282   /**
 283    * Explicitly declare the entity api name.
 284    */
 285   public function getDefaultEntity() {
 286     return 'Profile';
 287   }
 288
 289   /**
 290    * Pre processing work done here.
 291    *
 292    * gets session variables for table name, id of entity in table, type of entity and stores them.
 293    */
 294   public function preProcess() {
 295     $this->_id = $this->get('id');
 296     $this->_profileIds = $this->get('profileIds');
 297     $this->_grid = CRM_Utils_Request::retrieve('grid', 'Integer', $this);
 298     $this->_context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
 299
 300     //unset from session when $_GET doesn't have it
 301     //except when the form is submitted
 302     if (empty($_POST)) {
 303       if (!array_key_exists('multiRecord', $_GET)) {
 304         $this->set('multiRecord', NULL);
 305       }
 306       if (!array_key_exists('recordId', $_GET)) {
 307         $this->set('recordId', NULL);
 308       }
 309     }
 310
 311     $this->_session = CRM_Core_Session::singleton();
 312     $this->_currentUserID = $this->_session->get('userID');
 313
 314     if ($this->_mode == self::MODE_EDIT) {
 315       //specifies the action being done on a multi record field
 316       $multiRecordAction = CRM_Utils_Request::retrieve('multiRecord', 'String', $this);
 317       $this->_multiRecord = (!is_numeric($multiRecordAction)) ? CRM_Core_Action::resolve($multiRecordAction) : $multiRecordAction;
 318       if ($this->_multiRecord) {
 319         $this->set('multiRecord', $this->_multiRecord);
 320       }
 321
 322       if ($this->_multiRecord &&
 323         !in_array($this->_multiRecord, [CRM_Core_Action::UPDATE, CRM_Core_Action::ADD, CRM_Core_Action::DELETE])
 324       ) {
 325         CRM_Core_Error::fatal(ts('Proper action not specified for this custom value record profile'));
 326       }
 327     }
 328     $this->_duplicateButtonName = $this->getButtonName('upload', 'duplicate');
 329
 330     $gids = explode(',', CRM_Utils_Request::retrieve('gid', 'String', CRM_Core_DAO::$_nullObject, FALSE, 0));
 331
 332     if ((count($gids) > 1) && !$this->_profileIds && empty($this->_profileIds)) {
 333       if (!empty($gids)) {
 334         foreach ($gids as $pfId) {
 335           $this->_profileIds[] = CRM_Utils_Type::escape($pfId, 'Positive');
 336         }
 337       }
 338
 339       // check if we are rendering mixed profiles
 340       if (CRM_Core_BAO_UFGroup::checkForMixProfiles($this->_profileIds)) {
 341         CRM_Core_Error::fatal(ts('You cannot combine profiles of multiple types.'));
 342       }
 343
 344       // for now consider 1'st profile as primary profile and validate it
 345       // i.e check for profile type etc.
 346       // FIX ME: validations for other than primary
 347       $this->_gid = $this->_profileIds[0];
 348       $this->set('gid', $this->_gid);
 349       $this->set('profileIds', $this->_profileIds);
 350     }
 351
 352     if (!$this->_gid) {
 353       $this->_gid = CRM_Utils_Request::retrieve('gid', 'Positive', $this, FALSE, 0);
 354       $this->set('gid', $this->_gid);
 355     }
 356
 357     $this->_activityId = CRM_Utils_Request::retrieve('aid', 'Positive', $this, FALSE, 0, 'GET');
 358     if (is_numeric($this->_activityId)) {
 359       $latestRevisionId = CRM_Activity_BAO_Activity::getLatestActivityId($this->_activityId);
 360       if ($latestRevisionId) {
 361         $this->_activityId = $latestRevisionId;
 362       }
 363     }
 364     $this->_isContactActivityProfile = CRM_Core_BAO_UFField::checkContactActivityProfileType($this->_gid);
 365
 366     //get values for ufGroupName, captcha and dupe update.
 367     if ($this->_gid) {
 368       $dao = new CRM_Core_DAO_UFGroup();
 369       $dao->id = $this->_gid;
 370       if ($dao->find(TRUE)) {
 371         $this->_isUpdateDupe = $dao->is_update_dupe;
 372         $this->_isAddCaptcha = $dao->add_captcha;
 373         $this->_ufGroup = (array) $dao;
 374       }
 375       $dao->free();
 376
 377       if (!CRM_Utils_Array::value('is_active', $this->_ufGroup)) {
 378         CRM_Core_Error::fatal(ts('The requested profile (gid=%1) is inactive or does not exist.', [
 379           1 => $this->_gid,
 380         ]));
 381       }
 382     }
 383     $this->assign('ufGroupName', $this->_ufGroup['name']);
 384
 385     $gids = empty($this->_profileIds) ? $this->_gid : $this->_profileIds;
 386
 387     // if we don't have a gid use the default, else just use that specific gid
 388     if (($this->_mode == self::MODE_REGISTER || $this->_mode == self::MODE_CREATE) && !$this->_gid) {
 389       $this->_ctype = CRM_Utils_Request::retrieve('ctype', 'String', $this, FALSE, 'Individual', 'REQUEST');
 390       $this->_fields = CRM_Core_BAO_UFGroup::getRegistrationFields($this->_action, $this->_mode, $this->_ctype);
 391     }
 392     elseif ($this->_mode == self::MODE_SEARCH) {
 393       $this->_fields = CRM_Core_BAO_UFGroup::getListingFields($this->_action,
 394         CRM_Core_BAO_UFGroup::PUBLIC_VISIBILITY | CRM_Core_BAO_UFGroup::LISTINGS_VISIBILITY,
 395         FALSE,
 396         $gids,
 397         TRUE, NULL,
 398         $this->_skipPermission,
 399         CRM_Core_Permission::SEARCH
 400       );
 401     }
 402     else {
 403       $this->_fields = CRM_Core_BAO_UFGroup::getFields($gids, FALSE, NULL,
 404         NULL, NULL,
 405         FALSE, NULL,
 406         $this->_skipPermission,
 407         NULL,
 408         ($this->_action == CRM_Core_Action::ADD) ? CRM_Core_Permission::CREATE : CRM_Core_Permission::EDIT
 409       );
 410       $multiRecordFieldListing = FALSE;
 411       //using selector for listing of multi-record fields
 412       if ($this->_mode == self::MODE_EDIT && $this->_gid) {
 413         CRM_Core_BAO_UFGroup::shiftMultiRecordFields($this->_fields, $this->_multiRecordFields);
 414
 415         if ($this->_multiRecord) {
 416           if ($this->_multiRecord != CRM_Core_Action::ADD) {
 417             $this->_recordId = CRM_Utils_Request::retrieve('recordId', 'Positive', $this);
 418           }
 419           else {
 420             $this->_recordId = NULL;
 421             $this->set('recordId', NULL);
 422           }
 423           //record id is necessary for _multiRecord view and update/edit action
 424           if (!$this->_recordId
 425             && ($this->_multiRecord == CRM_Core_Action::UPDATE || $this->_multiRecord == CRM_Core_Action::DELETE)
 426           ) {
 427             CRM_Core_Error::fatal(ts('The requested Profile (gid=%1) requires record id while performing this action',
 428               [1 => $this->_gid]
 429             ));
 430           }
 431           elseif (empty($this->_multiRecordFields)) {
 432             CRM_Core_Error::fatal(ts('No Multi-Record Fields configured for this profile (gid=%1)',
 433               [1 => $this->_gid]
 434             ));
 435           }
 436
 437           $fieldId = CRM_Core_BAO_CustomField::getKeyID(key($this->_multiRecordFields));
 438           $customGroupDetails = CRM_Core_BAO_CustomGroup::getGroupTitles([$fieldId]);
 439           $this->_customGroupTitle = $customGroupDetails[$fieldId]['groupTitle'];
 440           $this->_customGroupId = $customGroupDetails[$fieldId]['groupID'];
 441
 442           if ($this->_multiRecord == CRM_Core_Action::UPDATE || $this->_multiRecord == CRM_Core_Action::DELETE) {
 443             //record exists check
 444             foreach ($this->_multiRecordFields as $key => $field) {
 445               $fieldIds[] = CRM_Core_BAO_CustomField::getKeyID($key);
 446             }
 447             $getValues = CRM_Core_BAO_CustomValueTable::getEntityValues($this->_id, NULL, $fieldIds, TRUE);
 448
 449             if (array_key_exists($this->_recordId, $getValues)) {
 450               $this->_recordExists = TRUE;
 451             }
 452             else {
 453               $this->_recordExists = FALSE;
 454               if ($this->_multiRecord & CRM_Core_Action::UPDATE) {
 455                 CRM_Core_Session::setStatus(ts('Note: The record %1 doesnot exists. Upon save a new record will be create', [1 => $this->_recordId]), ts('Record doesnot exist'), 'alert');
 456               }
 457             }
 458           }
 459           if ($this->_multiRecord & CRM_Core_Action::ADD) {
 460             $this->_maxRecordLimit = CRM_Core_BAO_CustomGroup::hasReachedMaxLimit($customGroupDetails[$fieldId]['groupID'], $this->_id);
 461             if ($this->_maxRecordLimit) {
 462               CRM_Core_Session::setStatus(ts('You cannot add a new record as  maximum allowed limit is reached'), ts('Sorry'), 'error');
 463             }
 464           }
 465
 466         }
 467         elseif (!empty($this->_multiRecordFields)
 468           && (!$this->_multiRecord || !in_array($this->_multiRecord, [
 469             CRM_Core_Action::DELETE,
 470             CRM_Core_Action::UPDATE,
 471           ]))
 472         ) {
 473           CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js', 1, 'html-header');
 474           //multi-record listing page
 475           $multiRecordFieldListing = TRUE;
 476           $page = new CRM_Profile_Page_MultipleRecordFieldsListing();
 477           $cs = $this->get('cs');
 478           $page->set('pageCheckSum', $cs);
 479           $page->set('contactId', $this->_id);
 480           $page->set('profileId', $this->_gid);
 481           $page->set('action', CRM_Core_Action::BROWSE);
 482           $page->set('multiRecordFieldListing', $multiRecordFieldListing);
 483           $page->run();
 484         }
 485       }
 486       $this->assign('multiRecordFieldListing', $multiRecordFieldListing);
 487
 488       // is profile double-opt in?
 489       if (!empty($this->_fields['group']) &&
 490         CRM_Core_BAO_UFGroup::isProfileDoubleOptin()
 491       ) {
 492         $emailField = FALSE;
 493         foreach ($this->_fields as $name => $values) {
 494           if (substr($name, 0, 6) == 'email-') {
 495             $emailField = TRUE;
 496           }
 497         }
 498
 499         if (!$emailField) {
 500           $status = ts("Email field should be included in profile if you want to use Group(s) when Profile double-opt in process is enabled.");
 501           $this->_session->setStatus($status);
 502         }
 503       }
 504
 505       //transferring all the multi-record custom fields in _fields
 506       if ($this->_multiRecord && !empty($this->_multiRecordFields)) {
 507         $this->_fields = $this->_multiRecordFields;
 508         $this->_multiRecordProfile = TRUE;
 509       }
 510       elseif ($this->_multiRecord && empty($this->_multiRecordFields)) {
 511         CRM_Core_Session::setStatus(ts('This feature is not currently available.'), ts('Sorry'), 'error');
 512         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm', 'reset=1'));
 513       }
 514     }
 515
 516     if (!is_array($this->_fields)) {
 517       CRM_Core_Session::setStatus(ts('This feature is not currently available.'), ts('Sorry'), 'error');
 518       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm', 'reset=1'));
 519     }
 520   }
 521
 522   /**
 523    * Set default values for the form. Note that in edit/view mode
 524    * the default values are retrieved from the database
 525    *
 526    */
 527   public function setDefaultsValues() {
 528     $this->_defaults = [];
 529     if ($this->_multiRecordProfile && ($this->_multiRecord == CRM_Core_Action::DELETE)) {
 530       return;
 531     }
 532
 533     if ($this->_mode != self::MODE_SEARCH) {
 534       // set default values for country / state to start with
 535       CRM_Core_BAO_UFGroup::setRegisterDefaults($this->_fields, $this->_defaults);
 536     }
 537
 538     if ($this->_id && !$this->_multiRecordProfile) {
 539       if ($this->_isContactActivityProfile) {
 540         $contactFields = $activityFields = [];
 541         foreach ($this->_fields as $fieldName => $field) {
 542           if (CRM_Utils_Array::value('field_type', $field) == 'Activity') {
 543             $activityFields[$fieldName] = $field;
 544           }
 545           else {
 546             $contactFields[$fieldName] = $field;
 547           }
 548         }
 549
 550         CRM_Core_BAO_UFGroup::setProfileDefaults($this->_id, $contactFields, $this->_defaults, TRUE);
 551         if ($this->_activityId) {
 552           CRM_Core_BAO_UFGroup::setComponentDefaults($activityFields, $this->_activityId, 'Activity', $this->_defaults, TRUE);
 553         }
 554       }
 555       else {
 556         CRM_Core_BAO_UFGroup::setProfileDefaults($this->_id, $this->_fields, $this->_defaults, TRUE);
 557       }
 558     }
 559
 560     //set custom field defaults
 561     if ($this->_multiRecordProfile) {
 562       foreach ($this->_multiRecordFields as $key => $field) {
 563         $fieldIds[] = CRM_Core_BAO_CustomField::getKeyID($key);
 564       }
 565
 566       $defaultValues = [];
 567       if ($this->_multiRecord && $this->_multiRecord == CRM_Core_Action::UPDATE) {
 568         $defaultValues = CRM_Core_BAO_CustomValueTable::getEntityValues($this->_id, NULL, $fieldIds, TRUE);
 569         if ($this->_recordExists == TRUE) {
 570           $defaultValues = $defaultValues[$this->_recordId];
 571         }
 572         else {
 573           $defaultValues = NULL;
 574         }
 575       }
 576
 577       if (!empty($defaultValues)) {
 578         foreach ($defaultValues as $key => $value) {
 579           $name = "custom_{$key}";
 580           $htmlType = $this->_multiRecordFields[$name]['html_type'];
 581           if ($htmlType != 'File') {
 582             if (isset($value)) {
 583               CRM_Core_BAO_CustomField::setProfileDefaults($key,
 584                 $name,
 585                 $this->_defaults,
 586                 $this->_id,
 587                 $this->_mode,
 588                 $value
 589               );
 590             }
 591             else {
 592               $this->_defaults[$name] = "";
 593             }
 594           }
 595
 596           if ($htmlType == 'File') {
 597             $entityId = $this->_id;
 598             if (CRM_Utils_Array::value('field_type', $field) == 'Activity' &&
 599               $this->_activityId
 600             ) {
 601               $entityId = $this->_activityId;
 602             }
 603
 604             $url = '';
 605             if (isset($value)) {
 606               $url = CRM_Core_BAO_CustomField::getFileURL($entityId, $key, $value);
 607             }
 608
 609             if ($url) {
 610               $customFiles[$name]['displayURL'] = ts("Attached File") . ": {$url['file_url']}";
 611
 612               $deleteExtra = ts("Are you sure you want to delete attached file?");
 613               $fileId = $url['file_id'];
 614               $fileHash = CRM_Core_BAO_File::generateFileHash($entityId, $fileId);
 615               $deleteURL = CRM_Utils_System::url('civicrm/file',
 616                 "reset=1&id={$fileId}&eid=$entityId&fid={$key}&action=delete&fcs={$fileHash}"
 617               );
 618               $text = ts("Delete Attached File");
 619               $customFiles[$field['name']]['deleteURL'] = "<a href=\"{$deleteURL}\" onclick = \"if (confirm( ' $deleteExtra ' )) this.href+='&amp;confirmed=1'; else return false;\">$text</a>";
 620
 621               // also delete the required rule that we've set on the form element
 622               $this->removeFileRequiredRules($name);
 623             }
 624           }
 625         }
 626       }
 627     }
 628     else {
 629       foreach ($this->_fields as $name => $field) {
 630         if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($name)) {
 631           $htmlType = $field['html_type'];
 632           if ((!isset($this->_defaults[$name]) || $htmlType == 'File') &&
 633             (CRM_Utils_Array::value('field_type', $field) != 'Activity')
 634           ) {
 635             CRM_Core_BAO_CustomField::setProfileDefaults($customFieldID,
 636               $name,
 637               $this->_defaults,
 638               $this->_id,
 639               $this->_mode
 640             );
 641           }
 642
 643           if ($htmlType == 'File') {
 644             $entityId = $this->_id;
 645             if (CRM_Utils_Array::value('field_type', $field) == 'Activity' && $this->_activityId) {
 646               $entityId = $this->_activityId;
 647             }
 648             $url = CRM_Core_BAO_CustomField::getFileURL($entityId, $customFieldID);
 649
 650             if ($url) {
 651               $customFiles[$field['name']]['displayURL'] = ts("Attached File") . ": {$url['file_url']}";
 652
 653               $deleteExtra = ts("Are you sure you want to delete attached file?");
 654               $fileId = $url['file_id'];
 655               $fileHash = CRM_Core_BAO_File::generateFileHash($entityId, $fileId); /* fieldId=$customFieldID */
 656               $deleteURL = CRM_Utils_System::url('civicrm/file',
 657                 "reset=1&id={$fileId}&eid=$entityId&fid={$customFieldID}&action=delete&fcs={$fileHash}"
 658               );
 659               $text = ts("Delete Attached File");
 660               $customFiles[$field['name']]['deleteURL'] = "<a href=\"{$deleteURL}\" onclick = \"if (confirm( ' $deleteExtra ' )) this.href+='&amp;confirmed=1'; else return false;\">$text</a>";
 661
 662               // also delete the required rule that we've set on the form element
 663               $this->removeFileRequiredRules($field['name']);
 664             }
 665           }
 666         }
 667       }
 668     }
 669     if (isset($customFiles)) {
 670       $this->assign('customFiles', $customFiles);
 671     }
 672
 673     if ($this->_multiRecordProfile) {
 674       $this->setDefaults($this->_defaults);
 675       return;
 676     }
 677
 678     if (!empty($this->_defaults['image_URL'])) {
 679       $this->assign("imageURL", CRM_Utils_File::getImageURL($this->_defaults['image_URL']));
 680       $this->removeFileRequiredRules('image_URL');
 681     }
 682
 683     $this->setDefaults($this->_defaults);
 684   }
 685
 686   /**
 687    * Build the form object.
 688    *
 689    */
 690   public function buildQuickForm() {
 691     $this->add('hidden', 'gid', $this->_gid);
 692
 693     switch ($this->_mode) {
 694       case self::MODE_CREATE:
 695       case self::MODE_EDIT:
 696       case self::MODE_REGISTER:
 697         CRM_Utils_Hook::buildProfile($this->_ufGroup['name']);
 698         break;
 699
 700       case self::MODE_SEARCH:
 701         CRM_Utils_Hook::searchProfile($this->_ufGroup['name']);
 702         break;
 703
 704       default:
 705     }
 706
 707     //lets have single status message, CRM-4363
 708     $return = FALSE;
 709     $statusMessage = NULL;
 710     if (($this->_multiRecord & CRM_Core_Action::ADD) && $this->_maxRecordLimit) {
 711       return;
 712     }
 713
 714     if (($this->_multiRecord & CRM_Core_Action::DELETE)) {
 715       if (!$this->_recordExists) {
 716         CRM_Core_Session::setStatus(ts('The record %1 doesnot exists', [1 => $this->_recordId]), ts('Record doesnot exists'), 'alert');
 717       }
 718       else {
 719         $this->assign('deleteRecord', TRUE);
 720       }
 721       return;
 722     }
 723
 724     CRM_Core_BAO_Address::checkContactSharedAddressFields($this->_fields, $this->_id);
 725
 726     // we should not allow component and mix profiles in search mode
 727     if ($this->_mode != self::MODE_REGISTER) {
 728       //check for mix profile fields (eg:  individual + other contact type)
 729       if (CRM_Core_BAO_UFField::checkProfileType($this->_gid)) {
 730         if (($this->_mode & self::MODE_EDIT) && $this->_isContactActivityProfile) {
 731           $errors = self::validateContactActivityProfile($this->_activityId, $this->_id, $this->_gid);
 732           if (!empty($errors)) {
 733             $statusMessage = array_pop($errors);
 734             $return = TRUE;
 735           }
 736         }
 737         else {
 738           $statusMessage = ts('Profile search, view and edit are not supported for Profiles which include fields for more than one record type.');
 739           $return = TRUE;
 740         }
 741       }
 742
 743       $profileType = CRM_Core_BAO_UFField::getProfileType($this->_gid);
 744
 745       if ($this->_id) {
 746         $contactTypes = CRM_Contact_BAO_Contact::getContactTypes($this->_id);
 747         $contactType = $contactTypes[0];
 748
 749         array_shift($contactTypes);
 750         $contactSubtypes = $contactTypes;
 751
 752         $profileSubType = FALSE;
 753         if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) {
 754           $profileSubType = $profileType;
 755           $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType);
 756         }
 757
 758         if (
 759           ($profileType != 'Contact' && !$this->_isContactActivityProfile) &&
 760           (($profileSubType && !empty($contactSubtypes) && (!in_array($profileSubType, $contactSubtypes))) ||
 761             ($profileType != $contactType))
 762         ) {
 763           $return = TRUE;
 764           if (!$statusMessage) {
 765             $statusMessage = ts("This profile is configured for contact type '%1'. It cannot be used to edit contacts of other types.",
 766                 [1 => $profileSubType ? $profileSubType : $profileType]);
 767           }
 768         }
 769       }
 770
 771       if (
 772       in_array(
 773         $profileType,
 774         ["Membership", "Participant", "Contribution"]
 775       )
 776       ) {
 777         $return = TRUE;
 778         if (!$statusMessage) {
 779           $statusMessage = ts('Profile is not configured for the selected action.');
 780         }
 781       }
 782     }
 783
 784     //lets have single status message,
 785     $this->assign('statusMessage', $statusMessage);
 786     if ($return) {
 787       return FALSE;
 788     }
 789
 790     $this->assign('id', $this->_id);
 791     $this->assign('mode', $this->_mode);
 792     $this->assign('action', $this->_action);
 793     $this->assign('fields', $this->_fields);
 794     $this->assign('fieldset', (isset($this->_fieldset)) ? $this->_fieldset : "");
 795
 796     // should we restrict what we display
 797     $admin = TRUE;
 798     if ($this->_mode == self::MODE_EDIT) {
 799       $admin = FALSE;
 800       // show all fields that are visible:
 801       // if we are a admin OR the same user OR acl-user with access to the profile
 802       // or we have checksum access to this contact (i.e. the user without a login) - CRM-5909
 803       if (
 804         CRM_Core_Permission::check('administer users') ||
 805         $this->_id == $this->_currentUserID ||
 806         $this->_isPermissionedChecksum ||
 807         in_array(
 808           $this->_gid,
 809           CRM_ACL_API::group(
 810             CRM_Core_Permission::EDIT,
 811             NULL,
 812             'civicrm_uf_group',
 813             CRM_Core_PseudoConstant::get('CRM_Core_DAO_UFField', 'uf_group_id')
 814           )
 815         )
 816       ) {
 817         $admin = TRUE;
 818       }
 819     }
 820
 821     // if false, user is not logged-in.
 822     $anonUser = FALSE;
 823     if (!$this->_currentUserID) {
 824       $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
 825       $primaryLocationType = $defaultLocationType->id;
 826       $anonUser = TRUE;
 827     }
 828     $this->assign('anonUser', $anonUser);
 829
 830     $addCaptcha = [];
 831     $emailPresent = FALSE;
 832
 833     // add the form elements
 834     foreach ($this->_fields as $name => $field) {
 835       // make sure that there is enough permission to expose this field
 836       if (!$admin && $field['visibility'] == 'User and User Admin Only') {
 837         unset($this->_fields[$name]);
 838         continue;
 839       }
 840
 841       // since the CMS manages the email field, suppress the email display if in
 842       // register mode which occur within the CMS form
 843       if ($this->_mode == self::MODE_REGISTER && substr($name, 0, 5) == 'email') {
 844         unset($this->_fields[$name]);
 845         continue;
 846       }
 847
 848       list($prefixName, $index) = CRM_Utils_System::explode('-', $name, 2);
 849
 850       CRM_Core_BAO_UFGroup::buildProfile($this, $field, $this->_mode);
 851
 852       if ($field['add_to_group_id']) {
 853         $addToGroupId = $field['add_to_group_id'];
 854       }
 855
 856       //build array for captcha
 857       if ($field['add_captcha']) {
 858         $addCaptcha[$field['group_id']] = $field['add_captcha'];
 859       }
 860
 861       if (($name == 'email-Primary') || ($name == 'email-' . isset($primaryLocationType) ? $primaryLocationType : "")) {
 862         $emailPresent = TRUE;
 863         $this->_mail = $name;
 864       }
 865     }
 866
 867     // add captcha only for create mode.
 868     if ($this->_mode == self::MODE_CREATE) {
 869       // suppress captcha for logged in users only
 870       if ($this->_currentUserID) {
 871         $this->_isAddCaptcha = FALSE;
 872       }
 873       elseif (!$this->_isAddCaptcha && !empty($addCaptcha)) {
 874         $this->_isAddCaptcha = TRUE;
 875       }
 876
 877       if ($this->_gid) {
 878         $dao = new CRM_Core_DAO_UFGroup();
 879         $dao->id = $this->_gid;
 880         $dao->addSelect();
 881         $dao->addSelect('is_update_dupe');
 882         if ($dao->find(TRUE)) {
 883           if ($dao->is_update_dupe) {
 884             $this->_isUpdateDupe = $dao->is_update_dupe;
 885           }
 886         }
 887       }
 888     }
 889     else {
 890       $this->_isAddCaptcha = FALSE;
 891     }
 892
 893     //finally add captcha to form.
 894     if ($this->_isAddCaptcha) {
 895       $captcha = CRM_Utils_ReCAPTCHA::singleton();
 896       $captcha->add($this);
 897     }
 898     $this->assign("isCaptcha", $this->_isAddCaptcha);
 899
 900     if ($this->_mode != self::MODE_SEARCH) {
 901       if (isset($addToGroupId)) {
 902         $this->_ufGroup['add_to_group_id'] = $addToGroupId;
 903       }
 904     }
 905
 906     //let's do set defaults for the profile
 907     $this->setDefaultsValues();
 908
 909     $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, NULL);
 910
 911     if ($this->_mode == self::MODE_CREATE || $this->_mode == self::MODE_EDIT) {
 912       CRM_Core_BAO_CMSUser::buildForm($this, $this->_gid, $emailPresent, $action);
 913     }
 914     else {
 915       $this->assign('showCMS', FALSE);
 916     }
 917
 918     $this->assign('groupId', $this->_gid);
 919
 920     // if view mode pls freeze it with the done button.
 921     if ($this->_action & CRM_Core_Action::VIEW) {
 922       $this->freeze();
 923     }
 924
 925     if ($this->_context == 'dialog') {
 926       $this->addElement(
 927         'submit',
 928         $this->_duplicateButtonName,
 929         ts('Save Matching Contact')
 930       );
 931     }
 932   }
 933
 934   /**
 935    * Validate profile and provided activity Id.
 936    *
 937    * @param int $activityId
 938    * @param int $contactId
 939    * @param int $gid
 940    *
 941    * @return array
 942    */
 943   public static function validateContactActivityProfile($activityId, $contactId, $gid) {
 944     $errors = [];
 945     if (!$activityId) {
 946       $errors[] = ts('Profile is using one or more activity fields, and is missing the activity Id (aid) in the URL.');
 947       return $errors;
 948     }
 949
 950     $activityDetails = [];
 951     $activityParams = ['id' => $activityId];
 952     CRM_Activity_BAO_Activity::retrieve($activityParams, $activityDetails);
 953
 954     if (empty($activityDetails)) {
 955       $errors[] = ts('Invalid Activity Id (aid).');
 956       return $errors;
 957     }
 958
 959     $profileActivityTypes = CRM_Core_BAO_UFGroup::groupTypeValues($gid, 'Activity');
 960
 961     if ((!empty($profileActivityTypes['Activity']) &&
 962         !in_array($activityDetails['activity_type_id'], $profileActivityTypes['Activity'])
 963       ) ||
 964       (!in_array($contactId, $activityDetails['assignee_contact']) &&
 965         !in_array($contactId, $activityDetails['target_contact'])
 966       )
 967     ) {
 968       $errors[] = ts('This activity cannot be edited or viewed via this profile.');
 969     }
 970
 971     return $errors;
 972   }
 973
 974   /**
 975    * Global form rule.
 976    *
 977    * @param array $fields
 978    *   The input form values.
 979    * @param array $files
 980    *   The uploaded files if any.
 981    * @param CRM_Core_Form $form
 982    *   The form object.
 983    *
 984    * @return bool|array
 985    *   true if no errors, else array of errors
 986    */
 987   public static function formRule($fields, $files, $form) {
 988     CRM_Utils_Hook::validateProfile($form->_ufGroup['name']);
 989
 990     // if no values, return
 991     if (empty($fields)) {
 992       return TRUE;
 993     }
 994
 995     $errors = [];
 996     $register = NULL;
 997
 998     // hack we use a -1 in options to indicate that its registration
 999     // ... and I can't remove that comment because even though it's clear as mud
1000     // perhaps someone will find it helpful in the absence of ANY OTHER EXPLANATION
1001     // as to what it means....
1002     if ($form->_id) {
1003       // @todo - wonder if it ever occurred to someone that if they didn't document this param
1004       // it might not be crystal clear why we have it....
1005       $form->_isUpdateDupe = 1;
1006     }
1007
1008     if ($form->_mode == CRM_Profile_Form::MODE_REGISTER) {
1009       $register = TRUE;
1010     }
1011
1012     // don't check for duplicates during registration validation: CRM-375
1013     if (!$register && empty($fields['_qf_Edit_upload_duplicate'])) {
1014       // fix for CRM-3240
1015       if (!empty($fields['email-Primary'])) {
1016         $fields['email'] = CRM_Utils_Array::value('email-Primary', $fields);
1017       }
1018
1019       // fix for CRM-6141
1020       if (!empty($fields['phone-Primary-1']) && empty($fields['phone-Primary'])) {
1021         $fields['phone-Primary'] = $fields['phone-Primary-1'];
1022       }
1023
1024       if (!$form->_id) {
1025         self::handleDuplicateChecking($errors, $fields, $form);
1026       }
1027     }
1028
1029     foreach ($fields as $key => $value) {
1030       list($fieldName, $locTypeId, $phoneTypeId) = CRM_Utils_System::explode('-', $key, 3);
1031       if ($fieldName == 'state_province' && !empty($fields["country-{$locTypeId}"])) {
1032         // Validate Country - State list
1033         $countryId = $fields["country-{$locTypeId}"];
1034         $stateProvinceId = $value;
1035
1036         if ($stateProvinceId && $countryId) {
1037           $stateProvinceDAO = new CRM_Core_DAO_StateProvince();
1038           $stateProvinceDAO->id = $stateProvinceId;
1039           $stateProvinceDAO->find(TRUE);
1040
1041           if ($stateProvinceDAO->country_id != $countryId) {
1042             // country mismatch hence display error
1043             $stateProvinces = CRM_Core_PseudoConstant::stateProvince();
1044             $countries = CRM_Core_PseudoConstant::country();
1045             $errors[$key] = "State/Province " . $stateProvinces[$stateProvinceId] . " is not part of " . $countries[$countryId] . ". It belongs to " . $countries[$stateProvinceDAO->country_id] . ".";
1046           }
1047         }
1048       }
1049
1050       if ($fieldName == 'county' && $fields["state_province-{$locTypeId}"]) {
1051         // Validate County - State list
1052         $stateProvinceId = $fields["state_province-{$locTypeId}"];
1053         $countyId = $value;
1054
1055         if ($countyId && $stateProvinceId) {
1056           $countyDAO = new CRM_Core_DAO_County();
1057           $countyDAO->id = $countyId;
1058           $countyDAO->find(TRUE);
1059
1060           if ($countyDAO->state_province_id != $stateProvinceId) {
1061             // state province mismatch hence display error
1062             $stateProvinces = CRM_Core_PseudoConstant::stateProvince();
1063             $counties = CRM_Core_PseudoConstant::county();
1064             $errors[$key] = "County " . $counties[$countyId] . " is not part of " . $stateProvinces[$stateProvinceId] . ". It belongs to " . $stateProvinces[$countyDAO->state_province_id] . ".";
1065           }
1066         }
1067       }
1068     }
1069     foreach (CRM_Contact_BAO_Contact::$_greetingTypes as $greeting) {
1070       if ($greetingType = CRM_Utils_Array::value($greeting, $fields)) {
1071         $customizedValue = CRM_Core_PseudoConstant::getKey('CRM_Contact_BAO_Contact', $greeting . '_id', 'Customized');
1072         if ($customizedValue == $greetingType && empty($fields[$greeting . '_custom'])) {
1073           $errors[$greeting . '_custom'] = ts('Custom  %1 is a required field if %1 is of type Customized.',
1074             [1 => ucwords(str_replace('_', ' ', $greeting))]
1075           );
1076         }
1077       }
1078     }
1079
1080     return empty($errors) ? TRUE : $errors;
1081   }
1082
1083   /**
1084    * Process the user submitted custom data values.
1085    *
1086    */
1087   public function postProcess() {
1088     $params = $this->controller->exportValues($this->_name);
1089
1090     //if the delete record button is clicked
1091     if ($this->_deleteButtonName) {
1092       if (!empty($_POST[$this->_deleteButtonName]) && $this->_recordId) {
1093         $filterParams['id'] = $this->_customGroupId;
1094         $returnProperties = ['is_multiple', 'table_name'];
1095         CRM_Core_DAO::commonRetrieve("CRM_Core_DAO_CustomGroup", $filterParams, $returnValues, $returnProperties);
1096         if (!empty($returnValues['is_multiple'])) {
1097           if ($tableName = CRM_Utils_Array::value('table_name', $returnValues)) {
1098             $sql = "DELETE FROM {$tableName} WHERE id = %1 AND entity_id = %2";
1099             $sqlParams = [
1100               1 => [$this->_recordId, 'Integer'],
1101               2 => [$this->_id, 'Integer'],
1102             ];
1103             CRM_Core_DAO::executeQuery($sql, $sqlParams);
1104             CRM_Core_Session::setStatus(ts('Your record has been deleted.'), ts('Deleted'), 'success');
1105           }
1106         }
1107         return;
1108       }
1109     }
1110     CRM_Utils_Hook::processProfile($this->_ufGroup['name']);
1111     if (!empty($params['image_URL'])) {
1112       CRM_Contact_BAO_Contact::processImageParams($params);
1113     }
1114
1115     $greetingTypes = [
1116       'addressee' => 'addressee_id',
1117       'email_greeting' => 'email_greeting_id',
1118       'postal_greeting' => 'postal_greeting_id',
1119     ];
1120
1121     $details = [];
1122     if ($this->_id) {
1123       $contactDetails = CRM_Contact_BAO_Contact::getHierContactDetails($this->_id,
1124         $greetingTypes
1125       );
1126       $details = $contactDetails[0][$this->_id];
1127     }
1128     if (!(!empty($details['addressee_id']) || !empty($details['email_greeting_id']) ||
1129       CRM_Utils_Array::value('postal_greeting_id', $details)
1130     )
1131     ) {
1132
1133       $profileType = CRM_Core_BAO_UFField::getProfileType($this->_gid);
1134       //Though Profile type is contact we need
1135       //Individual/Household/Organization for setting Greetings.
1136       if ($profileType == 'Contact') {
1137         $profileType = 'Individual';
1138         //if we editing Household/Organization.
1139         if ($this->_id) {
1140           $profileType = CRM_Contact_BAO_Contact::getContactType($this->_id);
1141         }
1142       }
1143       if (CRM_Contact_BAO_ContactType::isaSubType($profileType)) {
1144         $profileType = CRM_Contact_BAO_ContactType::getBasicType($profileType);
1145       }
1146
1147       foreach ($greetingTypes as $key => $value) {
1148         if (!array_key_exists($key, $params)) {
1149           $params[$key] = CRM_Contact_BAO_Contact_Utils::defaultGreeting($profileType, $key);
1150         }
1151       }
1152     }
1153
1154     $transaction = new CRM_Core_Transaction();
1155
1156     //used to send subscribe mail to the group which user want.
1157     //if the profile double option in is enabled
1158     $mailingType = [];
1159
1160     $result = NULL;
1161     foreach ($params as $name => $values) {
1162       if (substr($name, 0, 6) == 'email-') {
1163         $result['email'] = $values;
1164       }
1165     }
1166
1167     //array of group id, subscribed by contact
1168     $contactGroup = [];
1169     if (!empty($params['group']) &&
1170       CRM_Core_BAO_UFGroup::isProfileDoubleOptin()
1171     ) {
1172       $groupSubscribed = [];
1173       if (!empty($result['email'])) {
1174         if ($this->_id) {
1175           $contactGroups = new CRM_Contact_DAO_GroupContact();
1176           $contactGroups->contact_id = $this->_id;
1177           $contactGroups->status = 'Added';
1178           $contactGroups->find();
1179           $contactGroup = [];
1180           while ($contactGroups->fetch()) {
1181             $contactGroup[] = $contactGroups->group_id;
1182             $groupSubscribed[$contactGroups->group_id] = 1;
1183           }
1184         }
1185         foreach ($params['group'] as $key => $val) {
1186           if (!$val) {
1187             unset($params['group'][$key]);
1188             continue;
1189           }
1190           $groupTypes = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group',
1191             $key, 'group_type', 'id'
1192           );
1193           $groupType = explode(CRM_Core_DAO::VALUE_SEPARATOR,
1194             substr($groupTypes, 1, -1)
1195           );
1196           //filter group of mailing type and unset it from params
1197           if (in_array(2, $groupType)) {
1198             //if group is already subscribed , ignore it
1199             $groupExist = CRM_Utils_Array::key($key, $contactGroup);
1200             if (!isset($groupExist)) {
1201               $mailingType[] = $key;
1202               unset($params['group'][$key]);
1203             }
1204           }
1205         }
1206       }
1207     }
1208
1209     $addToGroupId = CRM_Utils_Array::value('add_to_group_id', $this->_ufGroup);
1210     if (!empty($addToGroupId)) {
1211       //run same check whether group is a mailing list
1212       $groupTypes = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group',
1213         $addToGroupId, 'group_type', 'id'
1214       );
1215       $groupType = explode(CRM_Core_DAO::VALUE_SEPARATOR,
1216         substr($groupTypes, 1, -1)
1217       );
1218       //filter group of mailing type and unset it from params
1219       if (in_array(2, $groupType) && !empty($result['email']) &&
1220         CRM_Core_BAO_UFGroup::isProfileAddToGroupDoubleOptin()
1221       ) {
1222         if (!count($contactGroup)) {
1223           //array of group id, subscribed by contact
1224           $contactGroup = [];
1225           if ($this->_id) {
1226             $contactGroups = new CRM_Contact_DAO_GroupContact();
1227             $contactGroups->contact_id = $this->_id;
1228             $contactGroups->status = 'Added';
1229             $contactGroups->find();
1230             $contactGroup = [];
1231             while ($contactGroups->fetch()) {
1232               $contactGroup[] = $contactGroups->group_id;
1233               $groupSubscribed[$contactGroups->group_id] = 1;
1234             }
1235           }
1236         }
1237         //if group is already subscribed , ignore it
1238         $groupExist = CRM_Utils_Array::key($addToGroupId, $contactGroup);
1239         if (!isset($groupExist)) {
1240           $mailingType[] = $addToGroupId;
1241           $addToGroupId = NULL;
1242         }
1243       }
1244       else {
1245         // since we are directly adding contact to group lets unset it from mailing
1246         if ($key = array_search($addToGroupId, $mailingType)) {
1247           unset($mailingType[$key]);
1248         }
1249       }
1250     }
1251
1252     if ($this->_grid) {
1253       $params['group'] = $groupSubscribed;
1254     }
1255
1256     // commenting below code, since we potentially
1257     // triggered maximum name field formatting cases during CRM-4430.
1258     // CRM-4343
1259     // $params['preserveDBName'] = true;
1260
1261     $profileFields = $this->_fields;
1262     if (($this->_mode & self::MODE_EDIT) && $this->_activityId && $this->_isContactActivityProfile) {
1263       $profileFields = $activityParams = [];
1264       foreach ($this->_fields as $fieldName => $field) {
1265         if (CRM_Utils_Array::value('field_type', $field) == 'Activity') {
1266           if (isset($params[$fieldName])) {
1267             $activityParams[$fieldName] = $params[$fieldName];
1268           }
1269           if (isset($params['activity_date_time'])) {
1270             $activityParams['activity_date_time'] = CRM_Utils_Date::processDate($params['activity_date_time'], $params['activity_date_time_time']);
1271           }
1272           if (!empty($params[$fieldName]) && isset($params["{$fieldName}_id"])) {
1273             $activityParams[$fieldName] = $params["{$fieldName}_id"];
1274           }
1275         }
1276         else {
1277           $profileFields[$fieldName] = $field;
1278         }
1279       }
1280
1281       if (!empty($activityParams)) {
1282         $activityParams['version'] = 3;
1283         $activityParams['id'] = $this->_activityId;
1284         $activityParams['skipRecentView'] = TRUE;
1285         civicrm_api('Activity', 'create', $activityParams);
1286       }
1287     }
1288
1289     if ($this->_multiRecord && $this->_recordId && $this->_multiRecordFields && $this->_recordExists) {
1290       $params['customRecordValues'][$this->_recordId] = array_keys($this->_multiRecordFields);
1291     }
1292
1293     $this->_id = CRM_Contact_BAO_Contact::createProfileContact(
1294       $params,
1295       $profileFields,
1296       $this->_id,
1297       $addToGroupId,
1298       $this->_gid,
1299       $this->_ctype,
1300       TRUE
1301     );
1302
1303     //mailing type group
1304     if (!empty($mailingType)) {
1305       // we send in the contactID so we match the same groups and are exact, rather than relying on email
1306       // CRM-8710
1307       CRM_Mailing_Event_BAO_Subscribe::commonSubscribe($mailingType, $result, $this->_id, 'profile');
1308     }
1309
1310     $ufGroups = [];
1311     if ($this->_gid) {
1312       $ufGroups[$this->_gid] = 1;
1313     }
1314     elseif ($this->_mode == self::MODE_REGISTER) {
1315       $ufGroups = CRM_Core_BAO_UFGroup::getModuleUFGroup('User Registration');
1316     }
1317
1318     foreach ($ufGroups as $gId => $val) {
1319       if ($notify = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $gId, 'notify')) {
1320         $values = CRM_Core_BAO_UFGroup::checkFieldsEmptyValues($gId, $this->_id, NULL);
1321         CRM_Core_BAO_UFGroup::commonSendMail($this->_id, $values);
1322       }
1323     }
1324
1325     //create CMS user (if CMS user option is selected in profile)
1326     if (!empty($params['cms_create_account']) &&
1327       ($this->_mode == self::MODE_CREATE || $this->_mode == self::MODE_EDIT)
1328     ) {
1329       $params['contactID'] = $this->_id;
1330       if (!CRM_Core_BAO_CMSUser::create($params, $this->_mail)) {
1331         CRM_Core_Session::setStatus(ts('Your profile is not saved and Account is not created.'), ts('Profile Error'), 'error');
1332         CRM_Core_Error::debug_log_message("Rolling back transaction as CMSUser Create failed in Profile_Form for contact " . $params['contactID']);
1333         $transaction->rollback();
1334         return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/profile/create',
1335           'reset=1&gid=' . $this->_gid
1336         ));
1337       }
1338     }
1339
1340     $transaction->commit();
1341   }
1342
1343   /**
1344    * @param null $suffix
1345    *
1346    * @return null|string
1347    */
1348   public function checkTemplateFileExists($suffix = NULL) {
1349     if ($this->_gid) {
1350       $templateFile = "CRM/Profile/Form/{$this->_gid}/{$this->_name}.{$suffix}tpl";
1351       $template = CRM_Core_Form::getTemplate();
1352       if ($template->template_exists($templateFile)) {
1353         return $templateFile;
1354       }
1355
1356       // lets see if we have customized by name
1357       $ufGroupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid, 'name');
1358       if ($ufGroupName) {
1359         $templateFile = "CRM/Profile/Form/{$ufGroupName}/{$this->_name}.{$suffix}tpl";
1360         if ($template->template_exists($templateFile)) {
1361           return $templateFile;
1362         }
1363       }
1364     }
1365     return NULL;
1366   }
1367
1368   /**
1369    * Use the form name to create the tpl file name.
1370    *
1371    * @return string
1372    */
1373   public function getTemplateFileName() {
1374     $fileName = $this->checkTemplateFileExists();
1375     return $fileName ? $fileName : parent::getTemplateFileName();
1376   }
1377
1378   /**
1379    * Default extra tpl file basically just replaces .tpl with .extra.tpl
1380    * i.e. we dont override
1381    *
1382    * @return string
1383    */
1384   public function overrideExtraTemplateFileName() {
1385     $fileName = $this->checkTemplateFileExists('extra.');
1386     return $fileName ? $fileName : parent::overrideExtraTemplateFileName();
1387   }
1388
1389 }