CRM/Contact/Page/View.php

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