drupal-civicrm/sites/all/modules/civicrm/CRM/Contact/Page/View.php

376 lines
12 KiB
PHP
Raw Normal View History

2018-01-14 15:10:16 +02:00
<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.7 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2017 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2017
*/
/**
* Main page for viewing contact.
*/
class CRM_Contact_Page_View extends CRM_Core_Page {
/**
* The id of the object being viewed (note/relationship etc)
*
* @int
*/
protected $_id;
/**
* The contact id of the contact being viewed
*
* @int
*/
protected $_contactId;
/**
* The action that we are performing
*
* @string
*/
protected $_action;
/**
* The permission we have on this contact
*
* @string
*/
protected $_permission;
/**
* Heart of the viewing process.
*
* The runner gets all the meta data for the contact and calls the appropriate type of page to view.
*/
public function preProcess() {
// process url params
$this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
$this->assign('id', $this->_id);
$qfKey = CRM_Utils_Request::retrieve('key', 'String', $this);
//validate the qfKey
if (!CRM_Utils_Rule::qfKey($qfKey)) {
$qfKey = NULL;
}
$this->assign('searchKey', $qfKey);
// retrieve the group contact id, so that we can get contact id
$gcid = CRM_Utils_Request::retrieve('gcid', 'Positive', $this);
if (!$gcid) {
$this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
}
else {
$this->_contactId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_GroupContact', $gcid, 'contact_id');
}
if (!$this->_contactId) {
CRM_Core_Error::statusBounce(
ts('We could not find a contact id.'),
CRM_Utils_System::url('civicrm/dashboard', 'reset=1')
);
}
// ensure that the id does exist
if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId, 'id') != $this->_contactId) {
CRM_Core_Error::statusBounce(
ts('A Contact with that ID does not exist: %1', array(1 => $this->_contactId)),
CRM_Utils_System::url('civicrm/dashboard', 'reset=1')
);
}
$this->assign('contactId', $this->_contactId);
// see if we can get prev/next positions from qfKey
$navContacts = array(
'prevContactID' => NULL,
'prevContactName' => NULL,
'nextContactID' => NULL,
'nextContactName' => NULL,
'nextPrevError' => 0,
);
if ($qfKey) {
$pos = CRM_Core_BAO_PrevNextCache::getPositions("civicrm search $qfKey",
$this->_contactId,
$this->_contactId
);
$found = FALSE;
if (isset($pos['prev'])) {
$navContacts['prevContactID'] = $pos['prev']['id1'];
$navContacts['prevContactName'] = $pos['prev']['data'];
$found = TRUE;
}
if (isset($pos['next'])) {
$navContacts['nextContactID'] = $pos['next']['id1'];
$navContacts['nextContactName'] = $pos['next']['data'];
$found = TRUE;
}
$context = CRM_Utils_Array::value('context', $_GET);
if (!$found) {
// seems like we did not find any contacts
// maybe due to bug CRM-9096
// however we should account for 1 contact results (which dont have prev next)
if (!$pos['foundEntry']) {
$navContacts['nextPrevError'] = 1;
}
}
elseif ($context) {
$this->assign('context', $context);
CRM_Utils_System::appendBreadCrumb(array(
array(
'title' => ts('Search Results'),
'url' => CRM_Utils_System::url("civicrm/contact/search/$context", array('qfKey' => $qfKey)),
),
));
}
}
$this->assign($navContacts);
$path = CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $this->_contactId);
CRM_Utils_System::appendBreadCrumb(array(array('title' => ts('View Contact'), 'url' => $path)));
if ($image_URL = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId, 'image_URL')) {
$this->assign("imageURL", CRM_Utils_File::getImageURL($image_URL));
}
// also store in session for future use
$session = CRM_Core_Session::singleton();
$session->set('view.id', $this->_contactId);
$this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
$this->assign('action', $this->_action);
// check logged in user permission
self::checkUserPermission($this);
list($displayName, $contactImage, $contactType, $contactSubtype, $contactImageUrl) = self::getContactDetails($this->_contactId);
$this->assign('displayName', $displayName);
$this->set('contactType', $contactType);
// note: there could still be multiple subtypes. We just trimming the outer separator.
$this->set('contactSubtype', trim($contactSubtype, CRM_Core_DAO::VALUE_SEPARATOR));
// add to recently viewed block
$isDeleted = (bool) CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId, 'is_deleted');
$recentOther = array(
'imageUrl' => $contactImageUrl,
'subtype' => $contactSubtype,
'isDeleted' => $isDeleted,
);
if (CRM_Contact_BAO_Contact_Permission::allow($this->_contactId, CRM_Core_Permission::EDIT)) {
$recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/add', "reset=1&action=update&cid={$this->_contactId}");
}
if (($session->get('userID') != $this->_contactId) && CRM_Core_Permission::check('delete contacts')
&& !$isDeleted
) {
$recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/delete', "reset=1&delete=1&cid={$this->_contactId}");
}
CRM_Utils_Recent::add($displayName,
CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$this->_contactId}"),
$this->_contactId,
$contactType,
$this->_contactId,
$displayName,
$recentOther
);
$this->assign('isDeleted', $isDeleted);
// set page title
$title = self::setTitle($this->_contactId, $isDeleted);
$this->assign('title', $title);
// Check if this is default domain contact CRM-10482
if (CRM_Contact_BAO_Contact::checkDomainContact($this->_contactId)) {
$this->assign('domainContact', TRUE);
}
else {
$this->assign('domainContact', FALSE);
}
// Add links for actions menu
self::addUrls($this, $this->_contactId);
if ($contactType == 'Organization' &&
CRM_Core_Permission::check('administer Multiple Organizations') &&
Civi::settings()->get('is_enabled')) {
//check is any relationship between the organization and groups
$groupOrg = CRM_Contact_BAO_GroupOrganization::hasGroupAssociated($this->_contactId);
if ($groupOrg) {
$groupOrganizationUrl = CRM_Utils_System::url('civicrm/group',
"reset=1&oid={$this->_contactId}"
);
$this->assign('groupOrganizationUrl', $groupOrganizationUrl);
}
}
}
/**
* Get meta details of the contact.
*
* @param int $contactId
*
* @return array
* contact fields in fixed order
*/
public static function getContactDetails($contactId) {
return list($displayName,
$contactImage,
$contactType,
$contactSubtype,
$contactImageUrl
) = CRM_Contact_BAO_Contact::getDisplayAndImage($contactId,
TRUE,
TRUE
);
}
/**
* @param $page
* @param int $contactID
*/
public static function checkUserPermission($page, $contactID = NULL) {
// check for permissions
$page->_permission = NULL;
if (!$contactID) {
$contactID = $page->_contactId;
}
// automatically grant permissin for users on their own record. makes
// things easier in dashboard
$session = CRM_Core_Session::singleton();
if ($session->get('userID') == $contactID && CRM_Core_Permission::check('edit my contact')) {
$page->assign('permission', 'edit');
$page->_permission = CRM_Core_Permission::EDIT;
// deleted contacts stuff should be (at best) only viewable
}
elseif (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'is_deleted') and CRM_Core_Permission::check('access deleted contacts')) {
$page->assign('permission', 'view');
$page->_permission = CRM_Core_Permission::VIEW;
}
elseif (CRM_Contact_BAO_Contact_Permission::allow($contactID, CRM_Core_Permission::EDIT)) {
$page->assign('permission', 'edit');
$page->_permission = CRM_Core_Permission::EDIT;
}
elseif (CRM_Contact_BAO_Contact_Permission::allow($contactID, CRM_Core_Permission::VIEW)) {
$page->assign('permission', 'view');
$page->_permission = CRM_Core_Permission::VIEW;
}
else {
$session->pushUserContext(CRM_Utils_System::url('civicrm', 'reset=1'));
CRM_Core_Error::statusBounce(ts('You do not have the necessary permission to view this contact.'));
}
}
/**
* @param int $contactId
* @param bool $isDeleted
*
* @return string
*/
public static function setTitle($contactId, $isDeleted = FALSE) {
static $contactDetails;
$displayName = $contactImage = NULL;
if (!isset($contactDetails[$contactId])) {
list($displayName, $contactImage) = self::getContactDetails($contactId);
$contactDetails[$contactId] = array(
'displayName' => $displayName,
'contactImage' => $contactImage,
'isDeceased' => (bool) CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactId, 'is_deceased'),
);
}
else {
$displayName = $contactDetails[$contactId]['displayName'];
$contactImage = $contactDetails[$contactId]['contactImage'];
}
// set page title
$title = "{$contactImage} {$displayName}";
if ($contactDetails[$contactId]['isDeceased']) {
$title .= ' <span class="crm-contact-deceased">(deceased)</span>';
}
if ($isDeleted) {
$title = "<del>{$title}</del>";
}
// Inline-edit places its own title on the page
CRM_Utils_System::setTitle('CiviCRM', '<span id="crm-remove-title" style="display:none">CiviCRM</span>');
return $title;
}
/**
* Add urls for display in the actions menu.
* @param CRM_Core_Page $obj
* @param int $cid
*/
public static function addUrls(&$obj, $cid) {
$uid = CRM_Core_BAO_UFMatch::getUFId($cid);
if ($uid) {
$userRecordUrl = CRM_Core_Config::singleton()->userSystem->getUserRecordUrl($cid);
$obj->assign('userRecordUrl', $userRecordUrl);
$obj->assign('userRecordId', $uid);
}
elseif (CRM_Core_Config::singleton()->userSystem->checkPermissionAddUser()) {
$userAddUrl = CRM_Utils_System::url('civicrm/contact/view/useradd', 'reset=1&action=add&cid=' . $cid);
$obj->assign('userAddUrl', $userAddUrl);
}
if (CRM_Core_Permission::check('access Contact Dashboard')) {
$dashboardURL = CRM_Utils_System::url('civicrm/user',
"reset=1&id={$cid}"
);
$obj->assign('dashboardURL', $dashboardURL);
}
// See if other modules want to add links to the activtity bar
$hookLinks = array();
CRM_Utils_Hook::links('view.contact.activity',
'Contact',
$cid,
$hookLinks
);
if (is_array($hookLinks)) {
$obj->assign('hookLinks', $hookLinks);
}
}
}