CRM/Contact/Page/View/Summary.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   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  * Main page for viewing contact.
  36  */
  37 class CRM_Contact_Page_View_Summary extends CRM_Contact_Page_View {
  38
  39   /**
  40    * Heart of the viewing process.
  41    *
  42    * The runner gets all the meta data for the contact and calls the appropriate type of page to view.
  43    */
  44   public function preProcess() {
  45     parent::preProcess();
  46
  47     // actions buttom contextMenu
  48     $menuItems = CRM_Contact_BAO_Contact::contextMenu($this->_contactId);
  49
  50     $this->assign('actionsMenuList', $menuItems);
  51
  52     //retrieve inline custom data
  53     $entityType = $this->get('contactType');
  54     if ($entitySubType = $this->get('contactSubtype')) {
  55       $entitySubType = explode(CRM_Core_DAO::VALUE_SEPARATOR,
  56         trim($entitySubType, CRM_Core_DAO::VALUE_SEPARATOR)
  57       );
  58     }
  59     $groupTree = CRM_Core_BAO_CustomGroup::getTree($entityType,
  60       NULL,
  61       $this->_contactId,
  62       NULL,
  63       $entitySubType
  64     );
  65
  66     CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $groupTree, FALSE, NULL, NULL, NULL, $this->_contactId);
  67
  68     // also create the form element for the activity links box
  69     $controller = new CRM_Core_Controller_Simple(
  70       'CRM_Activity_Form_ActivityLinks',
  71       ts('Activity Links'),
  72       NULL,
  73       FALSE,
  74       FALSE,
  75       TRUE
  76     );
  77     $controller->setEmbedded(TRUE);
  78     $controller->run();
  79   }
  80
  81   /**
  82    * Heart of the viewing process.
  83    *
  84    * The runner gets all the meta data for the contact and calls the appropriate type of page to view.
  85    */
  86   public function run() {
  87     $this->preProcess();
  88
  89     if ($this->_action & CRM_Core_Action::UPDATE) {
  90       $this->edit();
  91     }
  92     else {
  93       $this->view();
  94     }
  95
  96     return parent::run();
  97   }
  98
  99   /**
 100    * Edit name and address of a contact.
 101    */
 102   public function edit() {
 103     // set the userContext stack
 104     $session = CRM_Core_Session::singleton();
 105     $url = CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $this->_contactId);
 106     $session->pushUserContext($url);
 107
 108     $controller = new CRM_Core_Controller_Simple('CRM_Contact_Form_Contact', ts('Contact Page'), CRM_Core_Action::UPDATE);
 109     $controller->setEmbedded(TRUE);
 110     $controller->process();
 111     return $controller->run();
 112   }
 113
 114   /**
 115    * View summary details of a contact.
 116    */
 117   public function view() {
 118     // Add js for tabs, in-place editing, and jstree for tags
 119     CRM_Core_Resources::singleton()
 120       ->addScriptFile('civicrm', 'templates/CRM/Contact/Page/View/Summary.js', 2, 'html-header')
 121       ->addStyleFile('civicrm', 'css/contactSummary.css', 2, 'html-header')
 122       ->addScriptFile('civicrm', 'templates/CRM/common/TabHeader.js', 1, 'html-header')
 123       ->addSetting(array(
 124         'summaryPrint' => array('mode' => $this->_print),
 125         'tabSettings' => array('active' => CRM_Utils_Request::retrieve('selectedChild', 'String', $this, FALSE, 'summary')),
 126       ));
 127     $this->assign('summaryPrint', $this->_print);
 128     $session = CRM_Core_Session::singleton();
 129     $url = CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $this->_contactId);
 130     $session->pushUserContext($url);
 131     $this->assignFieldMetadataToTemplate('Contact');
 132
 133     $params = array();
 134     $defaults = array();
 135
 136     $params['id'] = $params['contact_id'] = $this->_contactId;
 137     $params['noRelationships'] = $params['noNotes'] = $params['noGroups'] = TRUE;
 138     $contact = CRM_Contact_BAO_Contact::retrieve($params, $defaults, TRUE);
 139     // Let summary page know if outbound mail is disabled so email links can be built conditionally
 140     $mailingBackend = Civi::settings()->get('mailing_backend');
 141     $this->assign('mailingOutboundOption', $mailingBackend['outBound_option']);
 142
 143     $communicationType = array(
 144       'phone' => array(
 145         'type' => 'phoneType',
 146         'id' => 'phone_type',
 147         'daoName' => 'CRM_Core_DAO_Phone',
 148         'fieldName' => 'phone_type_id',
 149       ),
 150       'im' => array(
 151         'type' => 'IMProvider',
 152         'id' => 'provider',
 153         'daoName' => 'CRM_Core_DAO_IM',
 154         'fieldName' => 'provider_id',
 155       ),
 156       'website' => array(
 157         'type' => 'websiteType',
 158         'id' => 'website_type',
 159         'daoName' => 'CRM_Core_DAO_Website',
 160         'fieldName' => 'website_type_id',
 161       ),
 162       'address' => array('skip' => TRUE, 'customData' => 1),
 163       'email' => array('skip' => TRUE),
 164       'openid' => array('skip' => TRUE),
 165     );
 166
 167     foreach ($communicationType as $key => $value) {
 168       if (!empty($defaults[$key])) {
 169         foreach ($defaults[$key] as & $val) {
 170           CRM_Utils_Array::lookupValue($val, 'location_type', CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id', array('labelColumn' => 'display_name')), FALSE);
 171           if (empty($value['skip'])) {
 172             $daoName = $value['daoName'];
 173             $pseudoConst = $daoName::buildOptions($value['fieldName'], 'get');
 174             CRM_Utils_Array::lookupValue($val, $value['id'], $pseudoConst, FALSE);
 175           }
 176         }
 177         if (isset($value['customData'])) {
 178           foreach ($defaults[$key] as $blockId => $blockVal) {
 179             $idValue = $blockVal['id'];
 180             if ($key == 'address') {
 181               if (!empty($blockVal['master_id'])) {
 182                 $idValue = $blockVal['master_id'];
 183               }
 184             }
 185             $groupTree = CRM_Core_BAO_CustomGroup::getTree(ucfirst($key), NULL, $idValue);
 186             // we setting the prefix to dnc_ below so that we don't overwrite smarty's grouptree var.
 187             $defaults[$key][$blockId]['custom'] = CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $groupTree, FALSE, NULL, "dnc_");
 188           }
 189           // reset template variable since that won't be of any use, and could be misleading
 190           $this->assign("dnc_viewCustomData", NULL);
 191         }
 192       }
 193     }
 194
 195     if (!empty($defaults['gender_id'])) {
 196       $defaults['gender_display'] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'gender_id', $defaults['gender_id']);
 197     }
 198
 199     $communicationStyle = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'communication_style_id');
 200     if (!empty($communicationStyle)) {
 201       if (!empty($defaults['communication_style_id'])) {
 202         $defaults['communication_style_display'] = $communicationStyle[CRM_Utils_Array::value('communication_style_id', $defaults)];
 203       }
 204       else {
 205         // Make sure the field is displayed as long as it is active, even if it is unset for this contact.
 206         $defaults['communication_style_display'] = '';
 207       }
 208     }
 209
 210     // to make contact type label available in the template -
 211     $contactType = array_key_exists('contact_sub_type', $defaults) ? $defaults['contact_sub_type'] : $defaults['contact_type'];
 212     $defaults['contact_type_label'] = CRM_Contact_BAO_ContactType::contactTypePairs(TRUE, $contactType, ', ');
 213
 214     // get contact tags
 215     $contactTags = CRM_Core_BAO_EntityTag::getContactTags($this->_contactId);
 216
 217     if (!empty($contactTags)) {
 218       $defaults['contactTag'] = $contactTags;
 219       $defaults['allTags'] = CRM_Core_BAO_Tag::getTagsUsedFor('civicrm_contact', FALSE);
 220     }
 221
 222     $defaults['privacy_values'] = CRM_Core_SelectValues::privacy();
 223
 224     //Show blocks only if they are visible in edit form
 225     $this->_editOptions = CRM_Core_BAO_Setting::valueOptions(
 226       CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 227       'contact_edit_options'
 228     );
 229
 230     foreach ($this->_editOptions as $blockName => $value) {
 231       $varName = '_show' . $blockName;
 232       $this->$varName = $value;
 233       $this->assign(substr($varName, 1), $this->$varName);
 234     }
 235
 236     // get contact name of shared contact names
 237     $sharedAddresses = array();
 238     $shareAddressContactNames = CRM_Contact_BAO_Contact_Utils::getAddressShareContactNames($defaults['address']);
 239     foreach ($defaults['address'] as $key => $addressValue) {
 240       if (!empty($addressValue['master_id']) &&
 241         !$shareAddressContactNames[$addressValue['master_id']]['is_deleted']
 242       ) {
 243         $sharedAddresses[$key]['shared_address_display'] = array(
 244           'address' => $addressValue['display'],
 245           'name' => $shareAddressContactNames[$addressValue['master_id']]['name'],
 246         );
 247       }
 248     }
 249     $this->assign('sharedAddresses', $sharedAddresses);
 250
 251     //get the current employer name
 252     if (CRM_Utils_Array::value('contact_type', $defaults) == 'Individual') {
 253       if ($contact->employer_id && $contact->organization_name) {
 254         $defaults['current_employer'] = $contact->organization_name;
 255         $defaults['current_employer_id'] = $contact->employer_id;
 256       }
 257     }
 258
 259     $defaults['external_identifier'] = $contact->external_identifier;
 260     $this->assign($defaults);
 261
 262     // FIXME: when we sort out TZ isssues with DATETIME/TIMESTAMP, we can skip next query
 263     // also assign the last modifed details
 264     $lastModified = CRM_Core_BAO_Log::lastModified($this->_contactId, 'civicrm_contact');
 265     $this->assign_by_ref('lastModified', $lastModified);
 266
 267     $this->_viewOptions = CRM_Core_BAO_Setting::valueOptions(
 268       CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 269       'contact_view_options',
 270       TRUE
 271     );
 272
 273     $changeLog = $this->_viewOptions['log'];
 274     $this->assign_by_ref('changeLog', $changeLog);
 275
 276     $this->assign('allTabs', $this->getTabs());
 277
 278     // hook for contact summary
 279     // ignored but needed to prevent warnings
 280     $contentPlacement = CRM_Utils_Hook::SUMMARY_BELOW;
 281     CRM_Utils_Hook::summary($this->_contactId, $content, $contentPlacement);
 282     if ($content) {
 283       $this->assign_by_ref('hookContent', $content);
 284       $this->assign('hookContentPlacement', $contentPlacement);
 285     }
 286   }
 287
 288   /**
 289    * @return string
 290    */
 291   public function getTemplateFileName() {
 292     if ($this->_contactId) {
 293       $contactSubtypes = $this->get('contactSubtype') ? explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->get('contactSubtype')) : array();
 294
 295       // there could be multiple subtypes. We check templates for each of the subtype, and return the first one found.
 296       foreach ($contactSubtypes as $csType) {
 297         if ($csType) {
 298           $templateFile = "CRM/Contact/Page/View/SubType/{$csType}.tpl";
 299           $template = CRM_Core_Page::getTemplate();
 300           if ($template->template_exists($templateFile)) {
 301             return $templateFile;
 302           }
 303         }
 304       }
 305     }
 306     return parent::getTemplateFileName();
 307   }
 308
 309   /**
 310    * @return array
 311    */
 312   public static function basicTabs() {
 313     return [
 314       [
 315         'id' => 'summary',
 316         'url' => '#contact-summary',
 317         'title' => ts('Summary'),
 318         'weight' => 0,
 319       ],
 320       [
 321         'id' => 'activity',
 322         'title' => ts('Activities'),
 323         'class' => 'livePage',
 324         'weight' => 70,
 325       ],
 326       [
 327         'id' => 'rel',
 328         'title' => ts('Relationships'),
 329         'class' => 'livePage',
 330         'weight' => 80,
 331       ],
 332       [
 333         'id' => 'group',
 334         'title' => ts('Groups'),
 335         'class' => 'ajaxForm',
 336         'weight' => 90,
 337       ],
 338       [
 339         'id' => 'note',
 340         'title' => ts('Notes'),
 341         'class' => 'livePage',
 342         'weight' => 100,
 343       ],
 344       [
 345         'id' => 'tag',
 346         'title' => ts('Tags'),
 347         'weight' => 110,
 348       ],
 349       [
 350         'id' => 'log',
 351         'title' => ts('Change Log'),
 352         'weight' => 120,
 353       ],
 354     ];
 355   }
 356
 357   /**
 358    * @return array
 359    * @throws \CRM_Core_Exception
 360    */
 361   public function getTabs() {
 362     $allTabs = [];
 363     $weight = 10;
 364
 365     foreach (CRM_Core_Component::getEnabledComponents() as $name => $component) {
 366       if (!empty($this->_viewOptions[$name]) &&
 367         CRM_Core_Permission::access($component->name)
 368       ) {
 369         $elem = $component->registerTab();
 370
 371         // FIXME: not very elegant, probably needs better approach
 372         // allow explicit id, if not defined, use keyword instead
 373         if (array_key_exists('id', $elem)) {
 374           $i = $elem['id'];
 375         }
 376         else {
 377           $i = $component->getKeyword();
 378         }
 379         $u = $elem['url'];
 380
 381         //appending isTest to url for test soft credit CRM-3891.
 382         //FIXME: hack ajax url.
 383         $q = "reset=1&force=1&cid={$this->_contactId}";
 384         if (CRM_Utils_Request::retrieve('isTest', 'Positive', $this)) {
 385           $q .= "&isTest=1";
 386         }
 387         $allTabs[] = [
 388           'id' => $i,
 389           'url' => CRM_Utils_System::url("civicrm/contact/view/$u", $q),
 390           'title' => $elem['title'],
 391           'weight' => $elem['weight'],
 392           'count' => CRM_Contact_BAO_Contact::getCountComponent($u, $this->_contactId),
 393           'class' => 'livePage',
 394         ];
 395       }
 396     }
 397
 398     // show the tabs only if user has generic access to CiviCRM
 399     $accessCiviCRM = CRM_Core_Permission::check('access CiviCRM');
 400     foreach (self::basicTabs() as $tab) {
 401       if ($tab['id'] == 'summary') {
 402         $allTabs[] = $tab;
 403       }
 404       elseif ($accessCiviCRM && !empty($this->_viewOptions[$tab['id']])) {
 405         $allTabs[] = $tab + [
 406           'url' => CRM_Utils_System::url(
 407             "civicrm/contact/view/{$tab['id']}",
 408             "reset=1&cid={$this->_contactId}"
 409           ),
 410           'count' => CRM_Contact_BAO_Contact::getCountComponent($tab['id'], $this->_contactId),
 411         ];
 412         $weight = $tab['weight'] + 10;
 413       }
 414     }
 415
 416     // now add all the custom tabs
 417     $entityType = $this->get('contactType');
 418     $activeGroups = CRM_Core_BAO_CustomGroup::getActiveGroups(
 419       $entityType,
 420       'civicrm/contact/view/cd',
 421       $this->_contactId
 422     );
 423
 424     foreach ($activeGroups as $group) {
 425       $id = "custom_{$group['id']}";
 426       $allTabs[] = [
 427         'id' => $id,
 428         'url' => CRM_Utils_System::url($group['path'], $group['query'] . "&selectedChild=$id"),
 429         'title' => $group['title'],
 430         'weight' => $weight,
 431         'count' => CRM_Contact_BAO_Contact::getCountComponent($id, $this->_contactId, $group['table_name']),
 432         'hideCount' => !$group['is_multiple'],
 433         'class' => 'livePage',
 434       ];
 435       $weight += 10;
 436     }
 437
 438     $context = ['contact_id' => $this->_contactId];
 439     // see if any other modules want to add any tabs
 440     CRM_Utils_Hook::tabs($allTabs, $this->_contactId);
 441     CRM_Utils_Hook::tabset('civicrm/contact/view', $allTabs, $context);
 442
 443     // now sort the tabs based on weight
 444     usort($allTabs, ['CRM_Utils_Sort', 'cmpFunc']);
 445     return $allTabs;
 446   }
 447
 448 }