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