CRM/Contact/Page/View.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Main page for viewing contact.
  38  *
  39  */
  40 class CRM_Contact_Page_View extends CRM_Core_Page {
  41
  42   /**
  43    * The id of the object being viewed (note/relationship etc)
  44    *
  45    * @int
  46    * @access protected
  47    */
  48   protected $_id;
  49
  50   /**
  51    * The contact id of the contact being viewed
  52    *
  53    * @int
  54    * @access protected
  55    */
  56   protected $_contactId;
  57
  58   /**
  59    * The action that we are performing
  60    *
  61    * @string
  62    * @access protected
  63    */
  64   protected $_action;
  65
  66   /**
  67    * The permission we have on this contact
  68    *
  69    * @string
  70    * @access protected
  71    */
  72   protected $_permission;
  73
  74   /**
  75    * Heart of the viewing process. The runner gets all the meta data for
  76    * the contact and calls the appropriate type of page to view.
  77    *
  78    * @return void
  79    * @access public
  80    *
  81    */
  82   function preProcess() {
  83     // process url params
  84     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
  85     $this->assign('id', $this->_id);
  86
  87     $qfKey = CRM_Utils_Request::retrieve('key', 'String', $this);
  88     //validate the qfKey
  89     if (!CRM_Utils_Rule::qfKey($qfKey)) {
  90       $qfKey = NULL;
  91     }
  92     $this->assign('searchKey', $qfKey);
  93
  94     // retrieve the group contact id, so that we can get contact id
  95     $gcid = CRM_Utils_Request::retrieve('gcid', 'Positive', $this);
  96
  97     if (!$gcid) {
  98       $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
  99     }
 100     else {
 101       $this->_contactId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_GroupContact', $gcid, 'contact_id');
 102     }
 103
 104     if (!$this->_contactId) {
 105       CRM_Core_Error::statusBounce(
 106         ts('We could not find a contact id.'),
 107         CRM_Utils_System::url('civicrm/dashboard', 'reset=1')
 108       );
 109     }
 110
 111     // ensure that the id does exist
 112     if ( CRM_Core_DAO::getFieldValue( 'CRM_Contact_DAO_Contact', $this->_contactId, 'id' ) != $this->_contactId ) {
 113       CRM_Core_Error::statusBounce(
 114         ts('A Contact with that ID does not exist: %1', array(1 => $this->_contactId)),
 115         CRM_Utils_System::url('civicrm/dashboard', 'reset=1')
 116       );
 117     }
 118
 119     $this->assign('contactId', $this->_contactId);
 120
 121     // see if we can get prev/next positions from qfKey
 122     $navContacts = array(
 123       'prevContactID' => NULL,
 124       'prevContactName' => NULL,
 125       'nextContactID' => NULL,
 126       'nextContactName' => NULL,
 127       'nextPrevError' => 0,
 128     );
 129     if ($qfKey) {
 130       $pos = CRM_Core_BAO_PrevNextCache::getPositions("civicrm search $qfKey",
 131         $this->_contactId,
 132         $this->_contactId
 133       );
 134       $found = FALSE;
 135
 136       if (isset($pos['prev'])) {
 137         $navContacts['prevContactID'] = $pos['prev']['id1'];
 138         $navContacts['prevContactName'] = $pos['prev']['data'];
 139         $found = TRUE;
 140       }
 141
 142       if (isset($pos['next'])) {
 143         $navContacts['nextContactID'] = $pos['next']['id1'];
 144         $navContacts['nextContactName'] = $pos['next']['data'];
 145         $found = TRUE;
 146       }
 147
 148       if (!$found) {
 149         // seems like we did not find any contacts
 150         // maybe due to bug CRM-9096
 151         // however we should account for 1 contact results (which dont have prev next)
 152         if (!$pos['foundEntry']) {
 153           $navContacts['nextPrevError'] = 1;
 154         }
 155       }
 156     }
 157     $this->assign($navContacts);
 158
 159     $path = CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $this->_contactId);
 160     CRM_Utils_System::appendBreadCrumb(array(array('title' => ts('View Contact'), 'url' => $path,)));
 161
 162     if ($image_URL = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId, 'image_URL')) {
 163       //CRM-7265 --time being fix.
 164       $config = CRM_Core_Config::singleton();
 165       $image_URL = str_replace('https://', 'http://', $image_URL);
 166       if (CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'enableSSL')) {
 167         $image_URL = str_replace('http://', 'https://', $image_URL);
 168       }
 169
 170       list($imageWidth, $imageHeight) = getimagesize(CRM_Utils_String::unstupifyUrl($image_URL));
 171       list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact::getThumbSize($imageWidth, $imageHeight);
 172       $this->assign("imageWidth", $imageWidth);
 173       $this->assign("imageHeight", $imageHeight);
 174       $this->assign("imageThumbWidth", $imageThumbWidth);
 175       $this->assign("imageThumbHeight", $imageThumbHeight);
 176       $this->assign("imageURL", $image_URL);
 177     }
 178
 179     // also store in session for future use
 180     $session = CRM_Core_Session::singleton();
 181     $session->set('view.id', $this->_contactId);
 182
 183     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
 184     $this->assign('action', $this->_action);
 185
 186     // check logged in user permission
 187     self::checkUserPermission($this);
 188
 189     list($displayName, $contactImage,
 190       $contactType, $contactSubtype, $contactImageUrl
 191     ) = self::getContactDetails($this->_contactId);
 192     $this->assign('displayName', $displayName);
 193
 194     $this->set('contactType', $contactType);
 195
 196     // note: there could still be multiple subtypes. We just trimming the outer separator.
 197     $this->set('contactSubtype', trim($contactSubtype, CRM_Core_DAO::VALUE_SEPARATOR));
 198
 199     // add to recently viewed block
 200     $isDeleted = (bool) CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId, 'is_deleted');
 201
 202     $recentOther = array(
 203       'imageUrl' => $contactImageUrl,
 204       'subtype' => $contactSubtype,
 205       'isDeleted' => $isDeleted,
 206     );
 207
 208     if (CRM_Contact_BAO_Contact_Permission::allow($this->_contactId, CRM_Core_Permission::EDIT)) {
 209       $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/add', "reset=1&action=update&cid={$this->_contactId}");
 210     }
 211
 212     if (($session->get('userID') != $this->_contactId) && CRM_Core_Permission::check('delete contacts')
 213       && !$isDeleted
 214     ) {
 215       $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/delete', "reset=1&delete=1&cid={$this->_contactId}");
 216     }
 217
 218     CRM_Utils_Recent::add($displayName,
 219       CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$this->_contactId}"),
 220       $this->_contactId,
 221       $contactType,
 222       $this->_contactId,
 223       $displayName,
 224       $recentOther
 225     );
 226     $this->assign('isDeleted', $isDeleted);
 227
 228     // set page title
 229     $title = self::setTitle($this->_contactId, $isDeleted);
 230     $this->assign('title', $title);
 231
 232     // Check if this is default domain contact CRM-10482
 233     if (CRM_Contact_BAO_Contact::checkDomainContact($this->_contactId)) {
 234       $this->assign('domainContact', TRUE);
 235     } else {
 236       $this->assign('domainContact', FALSE);
 237     }
 238
 239     // Add links for actions menu
 240     self::addUrls($this, $this->_contactId);
 241
 242     if ($contactType == 'Organization' &&
 243       CRM_Core_Permission::check('administer Multiple Organizations') &&
 244       CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME,
 245         'is_enabled'
 246       )
 247     ) {
 248       //check is any relationship between the organization and groups
 249       $groupOrg = CRM_Contact_BAO_GroupOrganization::hasGroupAssociated($this->_contactId);
 250       if ($groupOrg) {
 251         $groupOrganizationUrl = CRM_Utils_System::url('civicrm/group',
 252           "reset=1&oid={$this->_contactId}"
 253         );
 254         $this->assign('groupOrganizationUrl', $groupOrganizationUrl);
 255       }
 256     }
 257   }
 258
 259   /**
 260    * Get meta details of the contact.
 261    *
 262    * @param int $contactId
 263    *
 264    * @return array contact fields in fixed order
 265    * @access public
 266    */
 267   static function getContactDetails($contactId) {
 268     return list($displayName,
 269       $contactImage,
 270       $contactType,
 271       $contactSubtype,
 272       $contactImageUrl
 273     ) = CRM_Contact_BAO_Contact::getDisplayAndImage($contactId,
 274       TRUE,
 275       TRUE
 276     );
 277   }
 278
 279   /**
 280    * @param $page
 281    * @param int $contactID
 282    */
 283   static function checkUserPermission($page, $contactID = NULL) {
 284     // check for permissions
 285     $page->_permission = NULL;
 286
 287     if (!$contactID) {
 288       $contactID = $page->_contactId;
 289     }
 290
 291     // automatically grant permissin for users on their own record. makes
 292     // things easier in dashboard
 293     $session = CRM_Core_Session::singleton();
 294
 295     if ($session->get('userID') == $contactID && CRM_Core_Permission::check('edit my contact')) {
 296       $page->assign('permission', 'edit');
 297       $page->_permission = CRM_Core_Permission::EDIT;
 298       // deleted contacts’ stuff should be (at best) only viewable
 299     }
 300     elseif (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'is_deleted') and CRM_Core_Permission::check('access deleted contacts')) {
 301       $page->assign('permission', 'view');
 302       $page->_permission = CRM_Core_Permission::VIEW;
 303     }
 304     elseif (CRM_Contact_BAO_Contact_Permission::allow($contactID, CRM_Core_Permission::EDIT)) {
 305       $page->assign('permission', 'edit');
 306       $page->_permission = CRM_Core_Permission::EDIT;
 307     }
 308     elseif (CRM_Contact_BAO_Contact_Permission::allow($contactID, CRM_Core_Permission::VIEW)) {
 309       $page->assign('permission', 'view');
 310       $page->_permission = CRM_Core_Permission::VIEW;
 311     }
 312     else {
 313       $session->pushUserContext(CRM_Utils_System::url('civicrm', 'reset=1'));
 314       CRM_Core_Error::statusBounce(ts('You do not have the necessary permission to view this contact.'));
 315     }
 316   }
 317
 318   /**
 319    * @param int $contactId
 320    * @param bool $isDeleted
 321    *
 322    * @return string
 323    */
 324   static function setTitle($contactId, $isDeleted = FALSE) {
 325     static $contactDetails;
 326     $displayName = $contactImage = NULL;
 327     if (!isset($contactDetails[$contactId])) {
 328       list($displayName, $contactImage) = self::getContactDetails($contactId);
 329       $contactDetails[$contactId] = array(
 330         'displayName' => $displayName,
 331         'contactImage' => $contactImage,
 332       );
 333     }
 334     else {
 335       $displayName = $contactDetails[$contactId]['displayName'];
 336       $contactImage = $contactDetails[$contactId]['contactImage'];
 337     }
 338
 339     // set page title
 340     $title = "{$contactImage} {$displayName}";
 341     if ($isDeleted) {
 342       $title = "<del>{$title}</del>";
 343     }
 344
 345     // Inline-edit places its own title on the page
 346     CRM_Utils_System::setTitle('CiviCRM', '<span id="crm-remove-title" style="display:none">CiviCRM</span>');
 347
 348     return $title;
 349   }
 350
 351   /**
 352    * Add urls for display in the actions menu
 353    * @param CRM_Core_Page $obj
 354    * @param integer $cid
 355    */
 356   static function addUrls(&$obj, $cid) {
 357      $uid = CRM_Core_BAO_UFMatch::getUFId($cid);
 358
 359     if ($uid) {
 360       $userRecordUrl = CRM_Core_Config::singleton()->userSystem->getUserRecordUrl($cid);
 361       $obj->assign('userRecordUrl', $userRecordUrl);
 362       $obj->assign('userRecordId', $uid);
 363     }
 364     elseif (CRM_Core_Config::singleton()->userSystem->checkPermissionAddUser()) {
 365       $userAddUrl = CRM_Utils_System::url('civicrm/contact/view/useradd', 'reset=1&action=add&cid=' . $cid);
 366       $obj->assign('userAddUrl', $userAddUrl);
 367     }
 368
 369     if (CRM_Core_Permission::check('access Contact Dashboard')) {
 370       $dashboardURL = CRM_Utils_System::url('civicrm/user',
 371         "reset=1&id={$cid}"
 372       );
 373       $obj->assign('dashboardURL', $dashboardURL);
 374     }
 375
 376     // See if other modules want to add links to the activtity bar
 377     $hookLinks = array();
 378     CRM_Utils_Hook::links('view.contact.activity',
 379       'Contact',
 380       $cid,
 381       $hookLinks,
 382       CRM_Core_DAO::$_nullObject,
 383       CRM_Core_DAO::$_nullObject
 384     );
 385     if (is_array($hookLinks)) {
 386       $obj->assign('hookLinks', $hookLinks);
 387     }
 388   }
 389 }
 390