CRM/Activity/Form/Activity.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  * This class generates form components for Activity.
  36  */
  37 class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task {
  38
  39   /**
  40    * The id of the object being edited / created
  41    *
  42    * @var int
  43    */
  44   public $_activityId;
  45
  46   /**
  47    * Store activity ids when multiple activities are created.
  48    *
  49    * @var int
  50    */
  51   public $_activityIds = [];
  52
  53   /**
  54    * The id of activity type.
  55    *
  56    * @var int
  57    */
  58   public $_activityTypeId;
  59
  60   /**
  61    * The name of activity type.
  62    *
  63    * @var string
  64    */
  65   public $_activityTypeName;
  66
  67   /**
  68    * The id of currently viewed contact.
  69    *
  70    * @var int
  71    */
  72   public $_currentlyViewedContactId;
  73
  74   /**
  75    * The id of source contact and target contact.
  76    *
  77    * @var int
  78    */
  79   protected $_sourceContactId;
  80   protected $_targetContactId;
  81   protected $_asigneeContactId;
  82
  83   protected $_single;
  84
  85   public $_context;
  86   public $_compContext;
  87   public $_action;
  88   public $_activityTypeFile;
  89
  90   /**
  91    * The id of the logged in user, used when add / edit
  92    *
  93    * @var int
  94    */
  95   public $_currentUserId;
  96
  97   /**
  98    * The array of form field attributes.
  99    *
 100    * @var array
 101    */
 102   public $_fields;
 103
 104   /**
 105    * The the directory inside CRM, to include activity type file from
 106    *
 107    * @var string
 108    */
 109   protected $_crmDir = 'Activity';
 110
 111   /**
 112    * Survey activity.
 113    *
 114    * @var bool
 115    */
 116   protected $_isSurveyActivity;
 117
 118   protected $_values = [];
 119
 120   protected $unsavedWarn = TRUE;
 121
 122   /**
 123    *
 124    * Is it possible to create separate activities with this form?
 125    *
 126    * When TRUE, the form will ask whether the user wants to create separate
 127    * activities (if the user has specified multiple contacts in the "with"
 128    * field).
 129    *
 130    * When FALSE, the form will create one activity with all contacts together
 131    * and won't ask the user anything.
 132    *
 133    * Note: This is a class property so that child classes can turn off this
 134    * behavior (e.g. in CRM_Case_Form_Activity)
 135    *
 136    * @var bool
 137    *
 138    */
 139   protected $supportsActivitySeparation = TRUE;
 140
 141   public $submitOnce = TRUE;
 142
 143   /**
 144    * Explicitly declare the entity api name.
 145    *
 146    * @return string
 147    */
 148   public function getDefaultEntity() {
 149     return 'Activity';
 150   }
 151
 152   /**
 153    * The _fields var can be used by sub class to set/unset/edit the
 154    * form fields based on their requirement
 155    */
 156   public function setFields() {
 157     // Remove print document activity type
 158     $unwanted = CRM_Core_OptionGroup::values('activity_type', FALSE, FALSE, FALSE, "AND v.name = 'Print PDF Letter'");
 159     $activityTypes = array_diff_key(CRM_Core_PseudoConstant::ActivityType(FALSE), $unwanted);
 160
 161     $this->_fields = [
 162       'subject' => [
 163         'type' => 'text',
 164         'label' => ts('Subject'),
 165         'attributes' => CRM_Core_DAO::getAttribute('CRM_Activity_DAO_Activity', 'activity_subject'),
 166       ],
 167       'duration' => [
 168         'type' => 'number',
 169         'label' => ts('Duration'),
 170         'attributes' => ['class' => 'four', 'min' => 1],
 171         'required' => FALSE,
 172       ],
 173       'location' => [
 174         'type' => 'text',
 175         'label' => ts('Location'),
 176         'attributes' => CRM_Core_DAO::getAttribute('CRM_Activity_DAO_Activity', 'location'),
 177         'required' => FALSE,
 178       ],
 179       'details' => [
 180         'type' => 'wysiwyg',
 181         'label' => ts('Details'),
 182         'attributes' => ['class' => 'huge'],
 183         'required' => FALSE,
 184       ],
 185       'status_id' => [
 186         'type' => 'select',
 187         'required' => TRUE,
 188       ],
 189       'priority_id' => [
 190         'type' => 'select',
 191         'required' => TRUE,
 192       ],
 193       'source_contact_id' => [
 194         'type' => 'entityRef',
 195         'label' => ts('Added By'),
 196         'required' => FALSE,
 197       ],
 198       'target_contact_id' => [
 199         'type' => 'entityRef',
 200         'label' => ts('With Contact'),
 201         'attributes' => ['multiple' => TRUE, 'create' => TRUE],
 202       ],
 203       'assignee_contact_id' => [
 204         'type' => 'entityRef',
 205         'label' => ts('Assigned to'),
 206         'attributes' => [
 207           'multiple' => TRUE,
 208           'create' => TRUE,
 209           'api' => ['params' => ['is_deceased' => 0]],
 210         ],
 211       ],
 212       'activity_date_time' => [
 213         'type' => 'datepicker',
 214         'label' => ts('Date'),
 215         'required' => TRUE,
 216       ],
 217       'followup_assignee_contact_id' => [
 218         'type' => 'entityRef',
 219         'label' => ts('Assigned to'),
 220         'attributes' => [
 221           'multiple' => TRUE,
 222           'create' => TRUE,
 223           'api' => ['params' => ['is_deceased' => 0]],
 224         ],
 225       ],
 226       'followup_activity_type_id' => [
 227         'type' => 'select',
 228         'label' => ts('Followup Activity'),
 229         'attributes' => ['' => '- ' . ts('select activity') . ' -'] + $activityTypes,
 230         'extra' => ['class' => 'crm-select2'],
 231       ],
 232       // Add optional 'Subject' field for the Follow-up Activiity, CRM-4491
 233       'followup_activity_subject' => [
 234         'type' => 'text',
 235         'label' => ts('Subject'),
 236         'attributes' => CRM_Core_DAO::getAttribute('CRM_Activity_DAO_Activity', 'subject'),
 237       ],
 238     ];
 239   }
 240
 241   /**
 242    * Build the form object.
 243    */
 244   public function preProcess() {
 245     CRM_Core_Form_RecurringEntity::preProcess('civicrm_activity');
 246     $this->_atypefile = CRM_Utils_Array::value('atypefile', $_GET);
 247     $this->assign('atypefile', FALSE);
 248     if ($this->_atypefile) {
 249       $this->assign('atypefile', TRUE);
 250     }
 251
 252     $session = CRM_Core_Session::singleton();
 253     $this->_currentUserId = CRM_Core_Session::getLoggedInContactID();
 254
 255     $this->_currentlyViewedContactId = $this->get('contactId');
 256     if (!$this->_currentlyViewedContactId) {
 257       $this->_currentlyViewedContactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 258     }
 259     $this->assign('contactId', $this->_currentlyViewedContactId);
 260
 261     // Give the context.
 262     if (!isset($this->_context)) {
 263       $this->_context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
 264       if (CRM_Contact_Form_Search::isSearchContext($this->_context)) {
 265         $this->_context = 'search';
 266       }
 267       elseif (!in_array($this->_context, ['dashlet', 'case', 'dashletFullscreen'])
 268         && $this->_currentlyViewedContactId
 269       ) {
 270         $this->_context = 'activity';
 271       }
 272       $this->_compContext = CRM_Utils_Request::retrieve('compContext', 'String', $this);
 273     }
 274
 275     $this->assign('context', $this->_context);
 276
 277     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this);
 278
 279     if ($this->_action & CRM_Core_Action::DELETE) {
 280       if (!CRM_Core_Permission::check('delete activities')) {
 281         CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
 282       }
 283     }
 284
 285     // CRM-6957
 286     // When we come from contact search, activity id never comes.
 287     // So don't try to get from object, it might gives you wrong one.
 288
 289     // if we're not adding new one, there must be an id to
 290     // an activity we're trying to work on.
 291     if ($this->_action != CRM_Core_Action::ADD &&
 292       get_class($this->controller) != 'CRM_Contact_Controller_Search'
 293     ) {
 294       $this->_activityId = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 295     }
 296
 297     $this->_activityTypeId = CRM_Utils_Request::retrieve('atype', 'Positive', $this);
 298     $this->assign('atype', $this->_activityTypeId);
 299
 300     $this->assign('activityId', $this->_activityId);
 301
 302     // Check for required permissions, CRM-6264.
 303     if ($this->_activityId &&
 304       in_array($this->_action, [
 305         CRM_Core_Action::UPDATE,
 306         CRM_Core_Action::VIEW,
 307       ]) &&
 308       !CRM_Activity_BAO_Activity::checkPermission($this->_activityId, $this->_action)
 309     ) {
 310       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
 311     }
 312     if (($this->_action & CRM_Core_Action::VIEW) &&
 313       CRM_Activity_BAO_Activity::checkPermission($this->_activityId, CRM_Core_Action::UPDATE)
 314     ) {
 315       $this->assign('permission', 'edit');
 316       $this->assign('allow_edit_inbound_emails', CRM_Activity_BAO_Activity::checkEditInboundEmailsPermissions());
 317     }
 318
 319     if (!$this->_activityTypeId && $this->_activityId) {
 320       $this->_activityTypeId = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity',
 321         $this->_activityId,
 322         'activity_type_id'
 323       );
 324     }
 325
 326     // Assigning Activity type name.
 327     if ($this->_activityTypeId) {
 328       $activityTName = CRM_Core_OptionGroup::values('activity_type', FALSE, FALSE, FALSE, 'AND v.value = ' . $this->_activityTypeId, 'label');
 329       if ($activityTName[$this->_activityTypeId]) {
 330         $this->_activityTypeName = $activityTName[$this->_activityTypeId];
 331         $this->assign('activityTName', $activityTName[$this->_activityTypeId]);
 332       }
 333       // Set title.
 334       if (isset($activityTName)) {
 335         $activityName = CRM_Utils_Array::value($this->_activityTypeId, $activityTName);
 336
 337         if ($this->_currentlyViewedContactId) {
 338           $displayName = CRM_Contact_BAO_Contact::displayName($this->_currentlyViewedContactId);
 339           // Check if this is default domain contact CRM-10482.
 340           if (CRM_Contact_BAO_Contact::checkDomainContact($this->_currentlyViewedContactId)) {
 341             $displayName .= ' (' . ts('default organization') . ')';
 342           }
 343           CRM_Utils_System::setTitle($displayName . ' - ' . $activityName);
 344         }
 345         else {
 346           CRM_Utils_System::setTitle(ts('%1 Activity', [1 => $activityName]));
 347         }
 348       }
 349     }
 350
 351     // Check the mode when this form is called either single or as
 352     // search task action.
 353     if ($this->_activityTypeId ||
 354       $this->_context == 'standalone' ||
 355       $this->_currentlyViewedContactId
 356     ) {
 357       $this->_single = TRUE;
 358       $this->assign('urlPath', 'civicrm/activity');
 359     }
 360     else {
 361       // Set the appropriate action.
 362       $url = CRM_Utils_System::currentPath();
 363       $urlArray = explode('/', $url);
 364       $searchPath = array_pop($urlArray);
 365       $searchType = 'basic';
 366       $this->_action = CRM_Core_Action::BASIC;
 367       switch ($searchPath) {
 368         case 'basic':
 369           $searchType = $searchPath;
 370           $this->_action = CRM_Core_Action::BASIC;
 371           break;
 372
 373         case 'advanced':
 374           $searchType = $searchPath;
 375           $this->_action = CRM_Core_Action::ADVANCED;
 376           break;
 377
 378         case 'builder':
 379           $searchType = $searchPath;
 380           $this->_action = CRM_Core_Action::PROFILE;
 381           break;
 382
 383         case 'custom':
 384           $this->_action = CRM_Core_Action::COPY;
 385           $searchType = $searchPath;
 386           break;
 387       }
 388
 389       parent::preProcess();
 390       $this->_single = FALSE;
 391
 392       $this->assign('urlPath', "civicrm/contact/search/$searchType");
 393       $this->assign('urlPathVar', "_qf_Activity_display=true&qfKey={$this->controller->_key}");
 394     }
 395
 396     $this->assign('single', $this->_single);
 397     $this->assign('action', $this->_action);
 398
 399     if ($this->_action & CRM_Core_Action::VIEW) {
 400       // Get the tree of custom fields.
 401       $this->_groupTree = CRM_Core_BAO_CustomGroup::getTree('Activity', NULL,
 402         $this->_activityId, 0, $this->_activityTypeId
 403       );
 404     }
 405
 406     if ($this->_activityTypeId) {
 407       // Set activity type name and description to template.
 408       list($this->_activityTypeName, $activityTypeDescription) = CRM_Core_BAO_OptionValue::getActivityTypeDetails($this->_activityTypeId);
 409       $this->assign('activityTypeName', $this->_activityTypeName);
 410       $this->assign('activityTypeDescription', $activityTypeDescription);
 411     }
 412
 413     // set user context
 414     $urlParams = $urlString = NULL;
 415     $qfKey = CRM_Utils_Request::retrieve('key', 'String', $this);
 416     if (!$qfKey) {
 417       $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $this);
 418     }
 419
 420     // Validate the qfKey.
 421     if (!CRM_Utils_Rule::qfKey($qfKey)) {
 422       $qfKey = NULL;
 423     }
 424
 425     if ($this->_context == 'fulltext') {
 426       $keyName = '&qfKey';
 427       $urlParams = 'force=1';
 428       $urlString = 'civicrm/contact/search/custom';
 429       if ($this->_action == CRM_Core_Action::UPDATE) {
 430         $keyName = '&key';
 431         $urlParams .= '&context=fulltext&action=view';
 432         $urlString = 'civicrm/contact/view/activity';
 433       }
 434       if ($qfKey) {
 435         $urlParams .= "$keyName=$qfKey";
 436       }
 437       $this->assign('searchKey', $qfKey);
 438     }
 439     elseif (in_array($this->_context, [
 440       'standalone',
 441       'home',
 442       'dashlet',
 443       'dashletFullscreen',
 444     ])
 445     ) {
 446       $urlParams = 'reset=1';
 447       $urlString = 'civicrm/dashboard';
 448     }
 449     elseif ($this->_context == 'search') {
 450       $urlParams = 'force=1';
 451       if ($qfKey) {
 452         $urlParams .= "&qfKey=$qfKey";
 453       }
 454       $path = CRM_Utils_System::currentPath();
 455       if ($this->_compContext == 'advanced') {
 456         $urlString = 'civicrm/contact/search/advanced';
 457       }
 458       elseif ($path == 'civicrm/group/search'
 459         || $path == 'civicrm/contact/search'
 460         || $path == 'civicrm/contact/search/advanced'
 461         || $path == 'civicrm/contact/search/custom'
 462         || $path == 'civicrm/group/search'
 463       ) {
 464         $urlString = $path;
 465       }
 466       else {
 467         $urlString = 'civicrm/activity/search';
 468       }
 469       $this->assign('searchKey', $qfKey);
 470     }
 471     elseif ($this->_context != 'caseActivity') {
 472       $urlParams = "action=browse&reset=1&cid={$this->_currentlyViewedContactId}&selectedChild=activity";
 473       $urlString = 'civicrm/contact/view';
 474     }
 475
 476     if ($urlString) {
 477       $session->pushUserContext(CRM_Utils_System::url($urlString, $urlParams));
 478     }
 479
 480     // hack to retrieve activity type id from post variables
 481     if (!$this->_activityTypeId) {
 482       $this->_activityTypeId = CRM_Utils_Array::value('activity_type_id', $_POST);
 483     }
 484
 485     // when custom data is included in this page
 486     if (!empty($_POST['hidden_custom'])) {
 487       // We need to set it in the session for the code below to work.
 488       // CRM-3014
 489       // Need to assign custom data subtype to the template.
 490       $this->set('type', 'Activity');
 491       $this->set('subType', $this->_activityTypeId);
 492       $this->set('entityId', $this->_activityId);
 493       CRM_Custom_Form_CustomData::preProcess($this, NULL, $this->_activityTypeId, 1, 'Activity', $this->_activityId);
 494       CRM_Custom_Form_CustomData::buildQuickForm($this);
 495       CRM_Custom_Form_CustomData::setDefaultValues($this);
 496     }
 497
 498     // add attachments part
 499     CRM_Core_BAO_File::buildAttachment($this, 'civicrm_activity', $this->_activityId, NULL, TRUE);
 500
 501     // figure out the file name for activity type, if any
 502     if ($this->_activityTypeId &&
 503       $this->_activityTypeFile = CRM_Activity_BAO_Activity::getFileForActivityTypeId($this->_activityTypeId, $this->_crmDir)
 504     ) {
 505       $this->assign('activityTypeFile', $this->_activityTypeFile);
 506       $this->assign('crmDir', $this->_crmDir);
 507     }
 508
 509     $this->setFields();
 510
 511     if ($this->_activityTypeFile) {
 512       $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
 513       $className::preProcess($this);
 514     }
 515
 516     $this->_values = $this->get('values');
 517     if (!is_array($this->_values)) {
 518       $this->_values = [];
 519       if (isset($this->_activityId) && $this->_activityId) {
 520         $params = ['id' => $this->_activityId];
 521         CRM_Activity_BAO_Activity::retrieve($params, $this->_values);
 522       }
 523
 524       $this->set('values', $this->_values);
 525     }
 526
 527     if ($this->_action & CRM_Core_Action::UPDATE) {
 528       // We filter out alternatives, in case this is a stored e-mail, before sending to front-end
 529       if (isset($this->_values['details'])) {
 530         $this->_values['details'] = CRM_Utils_String::stripAlternatives($this->_values['details']) ?: '';
 531       }
 532
 533       if ($this->_activityTypeName === 'Inbound Email' &&
 534         !CRM_Core_Permission::check('edit inbound email basic information and content')
 535       ) {
 536         $this->_fields['details']['type'] = 'static';
 537       }
 538
 539       CRM_Core_Form_RecurringEntity::preProcess('civicrm_activity');
 540     }
 541
 542     if ($this->_action & CRM_Core_Action::VIEW) {
 543       $url = CRM_Utils_System::url(implode("/", $this->urlPath), "reset=1&id={$this->_activityId}&action=view&cid={$this->_values['source_contact_id']}");
 544       CRM_Utils_Recent::add(CRM_Utils_Array::value('subject', $this->_values, ts('(no subject)')),
 545         $url,
 546         $this->_values['id'],
 547         'Activity',
 548         $this->_values['source_contact_id'],
 549         $this->_values['source_contact']
 550       );
 551     }
 552   }
 553
 554   /**
 555    * Set default values for the form.
 556    *
 557    * For edit/view mode the default values are retrieved from the database.
 558    *
 559    * @return array
 560    */
 561   public function setDefaultValues() {
 562
 563     $defaults = $this->_values + CRM_Core_Form_RecurringEntity::setDefaultValues();
 564     // if we're editing...
 565     if (isset($this->_activityId)) {
 566
 567       if ($this->_context != 'standalone') {
 568         $this->assign('target_contact_value',
 569           CRM_Utils_Array::value('target_contact_value', $defaults)
 570         );
 571         $this->assign('assignee_contact_value',
 572           CRM_Utils_Array::value('assignee_contact_value', $defaults)
 573         );
 574       }
 575
 576       // Fixme: why are we getting the wrong keys from upstream?
 577       $defaults['target_contact_id'] = CRM_Utils_Array::value('target_contact', $defaults);
 578       $defaults['assignee_contact_id'] = CRM_Utils_Array::value('assignee_contact', $defaults);
 579
 580       // set default tags if exists
 581       $defaults['tag'] = implode(',', CRM_Core_BAO_EntityTag::getTag($this->_activityId, 'civicrm_activity'));
 582     }
 583     else {
 584       // if it's a new activity, we need to set default values for associated contact fields
 585       $this->_sourceContactId = $this->_currentUserId;
 586       $this->_targetContactId = $this->_currentlyViewedContactId;
 587
 588       $defaults['source_contact_id'] = $this->_sourceContactId;
 589       $defaults['target_contact_id'] = $this->_targetContactId;
 590     }
 591
 592     if (empty($defaults['activity_date_time'])) {
 593       $defaults['activity_date_time'] = date('Y-m-d H:i:s');
 594     }
 595
 596     if ($this->_activityTypeId) {
 597       $defaults['activity_type_id'] = $this->_activityTypeId;
 598     }
 599
 600     if (!$this->_single && !empty($this->_contactIds)) {
 601       $defaults['target_contact_id'] = $this->_contactIds;
 602     }
 603
 604     // CRM-15472 - 50 is around the practical limit of how many items a select2 entityRef can handle
 605     if ($this->_action == CRM_Core_Action::UPDATE && !empty($defaults['target_contact_id'])) {
 606       $count = count(is_array($defaults['target_contact_id']) ? $defaults['target_contact_id'] : explode(',', $defaults['target_contact_id']));
 607       if ($count > 50) {
 608         $this->freeze(['target_contact_id']);
 609       }
 610     }
 611
 612     if ($this->_action & (CRM_Core_Action::DELETE | CRM_Core_Action::RENEW)) {
 613       $this->assign('delName', CRM_Utils_Array::value('subject', $defaults));
 614     }
 615
 616     if ($this->_activityTypeFile) {
 617       $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
 618       $defaults += $className::setDefaultValues($this);
 619     }
 620     if (empty($defaults['priority_id'])) {
 621       $priority = CRM_Core_PseudoConstant::get('CRM_Activity_DAO_Activity', 'priority_id');
 622       $defaults['priority_id'] = array_search('Normal', $priority);
 623     }
 624     if (empty($defaults['status_id'])) {
 625       $defaults['status_id'] = CRM_Core_OptionGroup::getDefaultValue('activity_status');
 626     }
 627     return $defaults;
 628   }
 629
 630   /**
 631    * Build Quick form.
 632    *
 633    * @throws \CRM_Core_Exception
 634    * @throws \CiviCRM_API3_Exception
 635    */
 636   public function buildQuickForm() {
 637     if ($this->_action & (CRM_Core_Action::DELETE | CRM_Core_Action::RENEW)) {
 638       //enable form element (ActivityLinks sets this true)
 639       $this->assign('suppressForm', FALSE);
 640
 641       $button = ts('Delete');
 642       if ($this->_action & CRM_Core_Action::RENEW) {
 643         $button = ts('Restore');
 644       }
 645       $this->addButtons([
 646         [
 647           'type' => 'next',
 648           'name' => $button,
 649           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 650           'isDefault' => TRUE,
 651         ],
 652         [
 653           'type' => 'cancel',
 654           'name' => ts('Cancel'),
 655         ],
 656       ]);
 657       return;
 658     }
 659
 660     // Build other activity links.
 661     CRM_Activity_Form_ActivityLinks::commonBuildQuickForm($this);
 662
 663     // Enable form element (ActivityLinks sets this true).
 664     $this->assign('suppressForm', FALSE);
 665
 666     $element = &$this->add('select', 'activity_type_id', ts('Activity Type'),
 667       ['' => '- ' . ts('select') . ' -'] + $this->_fields['followup_activity_type_id']['attributes'],
 668       FALSE, [
 669         'onchange' => "CRM.buildCustomData( 'Activity', this.value );",
 670         'class' => 'crm-select2 required',
 671       ]
 672     );
 673
 674     // Freeze for update mode.
 675     if ($this->_action & CRM_Core_Action::UPDATE) {
 676       $element->freeze();
 677     }
 678
 679     // Call to RecurringEntity buildQuickForm for add/update mode.
 680     if ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD)) {
 681       CRM_Core_Form_RecurringEntity::buildQuickForm($this);
 682     }
 683
 684     foreach ($this->_fields as $field => $values) {
 685       if (!empty($this->_fields[$field])) {
 686         $attribute = CRM_Utils_Array::value('attributes', $values);
 687         $required = !empty($values['required']);
 688
 689         if ($values['type'] == 'select' && empty($attribute)) {
 690           $this->addSelect($field, ['entity' => 'activity'], $required);
 691         }
 692         elseif ($values['type'] == 'entityRef') {
 693           $this->addEntityRef($field, $values['label'], $attribute, $required);
 694         }
 695         else {
 696           $this->add($values['type'], $field, $values['label'], $attribute, $required, CRM_Utils_Array::value('extra', $values));
 697         }
 698       }
 699     }
 700
 701     // CRM-7362 --add campaigns.
 702     CRM_Campaign_BAO_Campaign::addCampaign($this, CRM_Utils_Array::value('campaign_id', $this->_values));
 703
 704     // Add engagement level CRM-7775
 705     $buildEngagementLevel = FALSE;
 706     if (CRM_Campaign_BAO_Campaign::isCampaignEnable() &&
 707       CRM_Campaign_BAO_Campaign::accessCampaign()
 708     ) {
 709       $buildEngagementLevel = TRUE;
 710       $this->addSelect('engagement_level', ['entity' => 'activity']);
 711       $this->addRule('engagement_level',
 712         ts('Please enter the engagement index as a number (integers only).'),
 713         'positiveInteger'
 714       );
 715     }
 716     $this->assign('buildEngagementLevel', $buildEngagementLevel);
 717
 718     // check for survey activity
 719     $this->_isSurveyActivity = FALSE;
 720
 721     if ($this->_activityId && CRM_Campaign_BAO_Campaign::isCampaignEnable() &&
 722       CRM_Campaign_BAO_Campaign::accessCampaign()
 723     ) {
 724
 725       $this->_isSurveyActivity = CRM_Campaign_BAO_Survey::isSurveyActivity($this->_activityId);
 726       if ($this->_isSurveyActivity) {
 727         $surveyId = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity',
 728           $this->_activityId,
 729           'source_record_id'
 730         );
 731         $responseOptions = CRM_Campaign_BAO_Survey::getResponsesOptions($surveyId);
 732         if ($responseOptions) {
 733           $this->add('select', 'result', ts('Result'),
 734             ['' => ts('- select -')] + array_combine($responseOptions, $responseOptions)
 735           );
 736         }
 737         $surveyTitle = NULL;
 738         if ($surveyId) {
 739           $surveyTitle = CRM_Core_DAO::getFieldValue('CRM_Campaign_DAO_Survey', $surveyId, 'title');
 740         }
 741         $this->assign('surveyTitle', $surveyTitle);
 742       }
 743     }
 744     $this->assign('surveyActivity', $this->_isSurveyActivity);
 745
 746     // Add the "Activity Separation" field
 747     $actionIsAdd = $this->_action != CRM_Core_Action::UPDATE;
 748     $separationIsPossible = $this->supportsActivitySeparation;
 749     if ($actionIsAdd && $separationIsPossible) {
 750       $this->addRadio(
 751         'separation',
 752         ts('Activity Separation'),
 753         [
 754           'separate' => ts('Create separate activities for each contact'),
 755           'combined' => ts('Create one activity with all contacts together'),
 756         ]
 757       );
 758     }
 759
 760     $this->addRule('duration',
 761       ts('Please enter the duration as number of minutes (integers only).'), 'positiveInteger'
 762     );
 763
 764     // Add followup date.
 765     $this->add('datepicker', 'followup_date', ts('in'));
 766
 767     // Only admins and case-workers can change the activity source
 768     if (!CRM_Core_Permission::check('administer CiviCRM') && $this->_context != 'caseActivity') {
 769       $this->getElement('source_contact_id')->freeze();
 770     }
 771
 772     //need to assign custom data type and subtype to the template
 773     $this->assign('customDataType', 'Activity');
 774     $this->assign('customDataSubType', $this->_activityTypeId);
 775     $this->assign('entityID', $this->_activityId);
 776
 777     $tags = CRM_Core_BAO_Tag::getColorTags('civicrm_activity');
 778
 779     if (!empty($tags)) {
 780       $this->add('select2', 'tag', ts('Tags'), $tags, FALSE, [
 781         'class' => 'huge',
 782         'placeholder' => ts('- select -'),
 783         'multiple' => TRUE,
 784       ]);
 785     }
 786
 787     // we need to hide activity tagset for special activities
 788     $specialActivities = ['Open Case'];
 789
 790     if (!in_array($this->_activityTypeName, $specialActivities)) {
 791       // build tag widget
 792       $parentNames = CRM_Core_BAO_Tag::getTagSet('civicrm_activity');
 793       CRM_Core_Form_Tag::buildQuickForm($this, $parentNames, 'civicrm_activity', $this->_activityId);
 794     }
 795
 796     // if we're viewing, we're assigning different buttons than for adding/editing
 797     if ($this->_action & CRM_Core_Action::VIEW) {
 798       if (isset($this->_groupTree)) {
 799         CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $this->_groupTree, FALSE, NULL, NULL, NULL, $this->_activityId);
 800       }
 801       // form should be frozen for view mode
 802       $this->freeze();
 803
 804       $this->addButtons([
 805         [
 806           'type' => 'cancel',
 807           'name' => ts('Done'),
 808         ],
 809       ]);
 810     }
 811     else {
 812       $this->addButtons([
 813         [
 814           'type' => 'upload',
 815           'name' => ts('Save'),
 816           'isDefault' => TRUE,
 817         ],
 818         [
 819           'type' => 'cancel',
 820           'name' => ts('Cancel'),
 821         ],
 822       ]);
 823     }
 824
 825     if ($this->_activityTypeFile) {
 826       $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
 827
 828       $className::buildQuickForm($this);
 829       $this->addFormRule([$className, 'formRule'], $this);
 830     }
 831
 832     $this->addFormRule(['CRM_Activity_Form_Activity', 'formRule'], $this);
 833
 834     $doNotNotifyAssigneeFor = (array) Civi::settings()
 835       ->get('do_not_notify_assignees_for');
 836     if (($this->_activityTypeId && in_array($this->_activityTypeId, $doNotNotifyAssigneeFor)) || !Civi::settings()
 837       ->get('activity_assignee_notification')) {
 838       $this->assign('activityAssigneeNotification', FALSE);
 839     }
 840     else {
 841       $this->assign('activityAssigneeNotification', TRUE);
 842     }
 843     $this->assign('doNotNotifyAssigneeFor', $doNotNotifyAssigneeFor);
 844   }
 845
 846   /**
 847    * Global form rule.
 848    *
 849    * @param array $fields
 850    *   The input form values.
 851    * @param array $files
 852    *   The uploaded files if any.
 853    * @param $self
 854    *
 855    * @return bool|array
 856    *   true if no errors, else array of errors
 857    */
 858   public static function formRule($fields, $files, $self) {
 859     // skip form rule if deleting
 860     if (CRM_Utils_Array::value('_qf_Activity_next_', $fields) == 'Delete') {
 861       return TRUE;
 862     }
 863     $errors = [];
 864     if ((array_key_exists('activity_type_id', $fields) || !$self->_single) && empty($fields['activity_type_id'])) {
 865       $errors['activity_type_id'] = ts('Activity Type is a required field');
 866     }
 867
 868     $activity_type_id = CRM_Utils_Array::value('activity_type_id', $fields);
 869     $activity_status_id = CRM_Utils_Array::value('status_id', $fields);
 870     $scheduled_status_id = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Scheduled');
 871
 872     if ($activity_type_id && $activity_status_id == $scheduled_status_id) {
 873       if ($activity_type_id == CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email')) {
 874         $errors['status_id'] = ts('You cannot record scheduled email activity.');
 875       }
 876       elseif ($activity_type_id == CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'SMS')) {
 877         $errors['status_id'] = ts('You cannot record scheduled SMS activity');
 878       }
 879     }
 880
 881     if (!empty($fields['followup_activity_type_id']) && empty($fields['followup_date'])) {
 882       $errors['followup_date'] = ts('Followup date is a required field.');
 883     }
 884     // Activity type is mandatory if subject or follow-up date is specified for an Follow-up activity, CRM-4515.
 885     if ((!empty($fields['followup_activity_subject']) || !empty($fields['followup_date'])) && empty($fields['followup_activity_type_id'])) {
 886       $errors['followup_activity_subject'] = ts('Follow-up Activity type is a required field.');
 887     }
 888
 889     // Check that a value has been set for the "activity separation" field if needed
 890     $separationIsPossible = $self->supportsActivitySeparation;
 891     $actionIsAdd = $self->_action == CRM_Core_Action::ADD;
 892     $hasMultipleTargetContacts = !empty($fields['target_contact_id']) && strpos($fields['target_contact_id'], ',') !== FALSE;
 893     $separationFieldIsEmpty = empty($fields['separation']);
 894     if ($separationIsPossible && $actionIsAdd && $hasMultipleTargetContacts && $separationFieldIsEmpty) {
 895       $errors['separation'] = ts('Activity Separation is a required field.');
 896     }
 897
 898     return $errors;
 899   }
 900
 901   /**
 902    * Process the form submission.
 903    *
 904    *
 905    * @param array $params
 906    *
 907    * @return array|null
 908    * @throws \CiviCRM_API3_Exception
 909    */
 910   public function postProcess($params = NULL) {
 911     if ($this->_action & CRM_Core_Action::DELETE) {
 912       $deleteParams = ['id' => $this->_activityId];
 913       $moveToTrash = CRM_Case_BAO_Case::isCaseActivity($this->_activityId);
 914       CRM_Activity_BAO_Activity::deleteActivity($deleteParams, $moveToTrash);
 915
 916       // delete tags for the entity
 917       $tagParams = [
 918         'entity_table' => 'civicrm_activity',
 919         'entity_id' => $this->_activityId,
 920       ];
 921
 922       CRM_Core_BAO_EntityTag::del($tagParams);
 923
 924       CRM_Core_Session::setStatus(ts("Selected Activity has been deleted successfully."), ts('Record Deleted'), 'success');
 925       return NULL;
 926     }
 927
 928     // store the submitted values in an array
 929     if (!$params) {
 930       $params = $this->controller->exportValues($this->_name);
 931     }
 932
 933     // Set activity type id.
 934     if (empty($params['activity_type_id'])) {
 935       $params['activity_type_id'] = $this->_activityTypeId;
 936     }
 937
 938     if (!empty($params['hidden_custom']) &&
 939       !isset($params['custom'])
 940     ) {
 941       $customFields = CRM_Core_BAO_CustomField::getFields('Activity', FALSE, FALSE,
 942         $this->_activityTypeId
 943       );
 944       $customFields = CRM_Utils_Array::crmArrayMerge($customFields,
 945         CRM_Core_BAO_CustomField::getFields('Activity', FALSE, FALSE,
 946           NULL, NULL, TRUE
 947         )
 948       );
 949       $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 950         $this->_activityId,
 951         'Activity'
 952       );
 953     }
 954
 955     // format params as arrays
 956     foreach (['target', 'assignee', 'followup_assignee'] as $name) {
 957       if (!empty($params["{$name}_contact_id"])) {
 958         $params["{$name}_contact_id"] = explode(',', $params["{$name}_contact_id"]);
 959       }
 960       else {
 961         $params["{$name}_contact_id"] = [];
 962       }
 963     }
 964
 965     // get ids for associated contacts
 966     if (!$params['source_contact_id']) {
 967       $params['source_contact_id'] = $this->_currentUserId;
 968     }
 969
 970     if (isset($this->_activityId)) {
 971       $params['id'] = $this->_activityId;
 972     }
 973
 974     // add attachments as needed
 975     CRM_Core_BAO_File::formatAttachment($params,
 976       $params,
 977       'civicrm_activity',
 978       $this->_activityId
 979     );
 980
 981     $params['is_multi_activity'] = CRM_Utils_Array::value('separation', $params) == 'separate';
 982
 983     $activity = [];
 984     if (!empty($params['is_multi_activity']) &&
 985       !CRM_Utils_Array::crmIsEmptyArray($params['target_contact_id'])
 986     ) {
 987       $targetContacts = $params['target_contact_id'];
 988       foreach ($targetContacts as $targetContactId) {
 989         $params['target_contact_id'] = [$targetContactId];
 990         // save activity
 991         $activity[] = $this->processActivity($params);
 992       }
 993     }
 994     else {
 995       // save activity
 996       $activity = $this->processActivity($params);
 997     }
 998
 999     // Redirect to contact page or activity view in standalone mode
1000     if ($this->_context == 'standalone') {
1001       if (count($params['target_contact_id']) == 1) {
1002         $url = CRM_Utils_System::url('civicrm/contact/view', ['cid' => CRM_Utils_Array::first($params['target_contact_id']), 'selectedChild' => 'activity']);
1003       }
1004       else {
1005         $url = CRM_Utils_System::url('civicrm/activity', ['action' => 'view', 'reset' => 1, 'id' => $this->_activityId]);
1006       }
1007       CRM_Core_Session::singleton()->pushUserContext($url);
1008     }
1009
1010     $activityIds = empty($this->_activityIds) ? [$this->_activityId] : $this->_activityIds;
1011     foreach ($activityIds as $activityId) {
1012       // set params for repeat configuration in create mode
1013       $params['entity_id'] = $activityId;
1014       $params['entity_table'] = 'civicrm_activity';
1015       if (!empty($params['entity_id']) && !empty($params['entity_table'])) {
1016         $checkParentExistsForThisId = CRM_Core_BAO_RecurringEntity::getParentFor($params['entity_id'], $params['entity_table']);
1017         if ($checkParentExistsForThisId) {
1018           $params['parent_entity_id'] = $checkParentExistsForThisId;
1019           $scheduleReminderDetails = CRM_Core_BAO_RecurringEntity::getReminderDetailsByEntityId($checkParentExistsForThisId, $params['entity_table']);
1020         }
1021         else {
1022           $params['parent_entity_id'] = $params['entity_id'];
1023           $scheduleReminderDetails = CRM_Core_BAO_RecurringEntity::getReminderDetailsByEntityId($params['entity_id'], $params['entity_table']);
1024         }
1025         if (property_exists($scheduleReminderDetails, 'id')) {
1026           $params['schedule_reminder_id'] = $scheduleReminderDetails->id;
1027         }
1028       }
1029       $params['dateColumns'] = ['activity_date_time'];
1030
1031       // Set default repetition start if it was not provided.
1032       if (empty($params['repetition_start_date'])) {
1033         $params['repetition_start_date'] = $params['activity_date_time'];
1034       }
1035
1036       // unset activity id
1037       unset($params['id']);
1038       $linkedEntities = [
1039         [
1040           'table' => 'civicrm_activity_contact',
1041           'findCriteria' => [
1042             'activity_id' => $activityId,
1043           ],
1044           'linkedColumns' => ['activity_id'],
1045           'isRecurringEntityRecord' => FALSE,
1046         ],
1047       ];
1048       CRM_Core_Form_RecurringEntity::postProcess($params, 'civicrm_activity', $linkedEntities);
1049     }
1050
1051     return ['activity' => $activity];
1052   }
1053
1054   /**
1055    * Process activity creation.
1056    *
1057    * @param array $params
1058    *   Associated array of submitted values.
1059    *
1060    * @return self|null|object
1061    */
1062   protected function processActivity(&$params) {
1063     $activityAssigned = [];
1064     $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
1065     $assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
1066     // format assignee params
1067     if (!CRM_Utils_Array::crmIsEmptyArray($params['assignee_contact_id'])) {
1068       //skip those assignee contacts which are already assigned
1069       //while sending a copy.CRM-4509.
1070       $activityAssigned = array_flip($params['assignee_contact_id']);
1071       if ($this->_activityId) {
1072         $assigneeContacts = CRM_Activity_BAO_ActivityContact::getNames($this->_activityId, $assigneeID);
1073         $activityAssigned = array_diff_key($activityAssigned, $assigneeContacts);
1074       }
1075     }
1076
1077     // call begin post process. Idea is to let injecting file do
1078     // any processing before the activity is added/updated.
1079     $this->beginPostProcess($params);
1080
1081     $activity = CRM_Activity_BAO_Activity::create($params);
1082
1083     // add tags if exists
1084     $tagParams = [];
1085     if (!empty($params['tag'])) {
1086       if (!is_array($params['tag'])) {
1087         $params['tag'] = explode(',', $params['tag']);
1088       }
1089
1090       $tagParams = array_fill_keys($params['tag'], 1);
1091     }
1092
1093     // Save static tags.
1094     CRM_Core_BAO_EntityTag::create($tagParams, 'civicrm_activity', $activity->id);
1095
1096     // Save free tags.
1097     if (isset($params['activity_taglist']) && !empty($params['activity_taglist'])) {
1098       CRM_Core_Form_Tag::postProcess($params['activity_taglist'], $activity->id, 'civicrm_activity', $this);
1099     }
1100
1101     // call end post process. Idea is to let injecting file do any
1102     // processing needed, after the activity has been added/updated.
1103     $this->endPostProcess($params, $activity);
1104
1105     // CRM-9590
1106     if (!empty($params['is_multi_activity'])) {
1107       $this->_activityIds[] = $activity->id;
1108     }
1109     else {
1110       $this->_activityId = $activity->id;
1111     }
1112
1113     // create follow up activity if needed
1114     $followupStatus = '';
1115     $followupActivity = NULL;
1116     if (!empty($params['followup_activity_type_id'])) {
1117       $followupActivity = CRM_Activity_BAO_Activity::createFollowupActivity($activity->id, $params);
1118       $followupStatus = ts('A followup activity has been scheduled.');
1119     }
1120
1121     // send copy to assignee contacts.CRM-4509
1122     $mailStatus = '';
1123
1124     if (Civi::settings()->get('activity_assignee_notification')
1125       && !in_array($activity->activity_type_id, Civi::settings()
1126         ->get('do_not_notify_assignees_for'))) {
1127       $activityIDs = [$activity->id];
1128       if ($followupActivity) {
1129         $activityIDs = array_merge($activityIDs, [$followupActivity->id]);
1130       }
1131       $assigneeContacts = CRM_Activity_BAO_ActivityAssignment::getAssigneeNames($activityIDs, TRUE, FALSE);
1132
1133       if (!CRM_Utils_Array::crmIsEmptyArray($params['assignee_contact_id'])) {
1134         $mailToContacts = [];
1135
1136         // Build an associative array with unique email addresses.
1137         foreach ($activityAssigned as $id => $dnc) {
1138           if (isset($id) && array_key_exists($id, $assigneeContacts)) {
1139             $mailToContacts[$assigneeContacts[$id]['email']] = $assigneeContacts[$id];
1140           }
1141         }
1142
1143         $sent = CRM_Activity_BAO_Activity::sendToAssignee($activity, $mailToContacts);
1144         if ($sent) {
1145           $mailStatus .= ts("A copy of the activity has also been sent to assignee contacts(s).");
1146         }
1147       }
1148
1149       // Also send email to follow-up activity assignees if set
1150       if ($followupActivity) {
1151         $mailToFollowupContacts = [];
1152         foreach ($assigneeContacts as $values) {
1153           if ($values['activity_id'] == $followupActivity->id) {
1154             $mailToFollowupContacts[$values['email']] = $values;
1155           }
1156         }
1157
1158         $sentFollowup = CRM_Activity_BAO_Activity::sendToAssignee($followupActivity, $mailToFollowupContacts);
1159         if ($sentFollowup) {
1160           $mailStatus .= '<br />' . ts("A copy of the follow-up activity has also been sent to follow-up assignee contacts(s).");
1161         }
1162       }
1163     }
1164
1165     // set status message
1166     $subject = '';
1167     if (!empty($params['subject'])) {
1168       $subject = "'" . $params['subject'] . "'";
1169     }
1170
1171     CRM_Core_Session::setStatus(ts('Activity %1 has been saved. %2 %3',
1172       [
1173         1 => $subject,
1174         2 => $followupStatus,
1175         3 => $mailStatus,
1176       ]
1177     ), ts('Saved'), 'success');
1178
1179     return $activity;
1180   }
1181
1182   /**
1183    * Shorthand for getting id by display name (makes code more readable)
1184    * @param $displayName
1185    * @return null|string
1186    */
1187   protected function _getIdByDisplayName($displayName) {
1188     return CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
1189       $displayName,
1190       'id',
1191       'sort_name'
1192     );
1193   }
1194
1195   /**
1196    * Shorthand for getting display name by id (makes code more readable)
1197    * @param $id
1198    * @return null|string
1199    */
1200   protected function _getDisplayNameById($id) {
1201     return CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
1202       $id,
1203       'sort_name',
1204       'id'
1205     );
1206   }
1207
1208   /**
1209    * Let injecting activity type file do any processing.
1210    * needed, before the activity is added/updated
1211    *
1212    * @param array $params
1213    */
1214   public function beginPostProcess(&$params) {
1215     if ($this->_activityTypeFile) {
1216       $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
1217       $className::beginPostProcess($this, $params);
1218     }
1219   }
1220
1221   /**
1222    * Let injecting activity type file do any processing
1223    * needed, after the activity has been added/updated
1224    *
1225    * @param array $params
1226    * @param $activity
1227    */
1228   public function endPostProcess(&$params, &$activity) {
1229     if ($this->_activityTypeFile) {
1230       $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
1231       $className::endPostProcess($this, $params, $activity);
1232     }
1233   }
1234
1235 }