CRM/Profile/Form.php

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