CRM/Activity/Form/Activity.php

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