3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * Create a page for displaying CiviCRM Profile Fields.
39 * Heart of this class is the run method which checks
40 * for action type and then displays the appropriate
44 class CRM_Profile_Page_Dynamic
extends CRM_Core_Page
{
47 * The contact id of the person we are viewing
54 * The profile group are are interested in
61 * The profile types we restrict this page to display
68 * Should we bypass permissions
72 protected $_skipPermission;
75 * Store profile ids if multiple profile ids are passed using comma separated.
76 * Currently lets implement this functionality only for dialog mode
78 protected $_profileIds = array();
81 * Contact profile having activity fields?
85 protected $_isContactActivityProfile = FALSE;
88 * Activity Id connected to the profile
92 protected $_activityId = NULL;
94 protected $_multiRecord = NULL;
96 protected $_recordId = NULL;
99 * fetch multirecord as well as non-multirecord fields
101 protected $_allFields = NULL;
112 * @param bool $skipPermission
113 * @param null $profileIds
115 * @return \CRM_Profile_Page_Dynamic
117 public function __construct($id, $gid, $restrict, $skipPermission = FALSE, $profileIds = NULL) {
118 parent
::__construct();
122 $this->_restrict
= $restrict;
123 $this->_skipPermission
= $skipPermission;
125 if (!array_key_exists('multiRecord', $_GET)) {
126 $this->set('multiRecord', NULL);
128 if (!array_key_exists('recordId', $_GET)) {
129 $this->set('recordId', NULL);
131 if (!array_key_exists('allFields', $_GET)) {
132 $this->set('allFields', NULL);
135 //specifies the action being done on a multi record field
136 $multiRecordAction = CRM_Utils_Request
::retrieve('multiRecord', 'String', $this);
138 $this->_multiRecord
= (!is_numeric($multiRecordAction)) ? CRM_Core_Action
::resolve($multiRecordAction) : $multiRecordAction;
139 if ($this->_multiRecord
) {
140 $this->set('multiRecord', $this->_multiRecord
);
143 if ($this->_multiRecord
& CRM_Core_Action
::VIEW
) {
144 $this->_recordId
= CRM_Utils_Request
::retrieve('recordId', 'Positive', $this);
145 $this->_allFields
= CRM_Utils_Request
::retrieve('allFields', 'Integer', $this);
149 $this->_profileIds
= $profileIds;
152 $this->_profileIds
= array($gid);
155 $this->_activityId
= CRM_Utils_Request
::retrieve('aid', 'Positive', $this, FALSE, 0, 'GET');
156 if (is_numeric($this->_activityId
)) {
157 $latestRevisionId = CRM_Activity_BAO_Activity
::getLatestActivityId($this->_activityId
);
158 if ($latestRevisionId) {
159 $this->_activityId
= $latestRevisionId;
162 $this->_isContactActivityProfile
= CRM_Core_BAO_UFField
::checkContactActivityProfileType($this->_gid
);
166 * Get the action links for this page.
170 public function &actionLinks() {
177 * This method is called after the page is created. It checks for the
178 * type of action and executes that action.
182 public function run() {
183 $template = CRM_Core_Smarty
::singleton();
184 if ($this->_id
&& $this->_gid
) {
186 // first check that id is part of the limit group id, CRM-4822
187 $limitListingsGroupsID = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup',
189 'limit_listings_group_id'
191 $config = CRM_Core_Config
::singleton();
192 if ($limitListingsGroupsID) {
194 if (!CRM_Contact_BAO_GroupContact
::isContactInGroup($this->_id
,
195 $limitListingsGroupsID
198 CRM_Utils_System
::setTitle(ts('Profile View - Permission Denied'));
199 return CRM_Core_Session
::setStatus(ts('You do not have permission to view this contact record. Contact the site administrator if you need assistance.'), ts('Permission Denied'), 'error');
203 $session = CRM_Core_Session
::singleton();
204 $userID = $session->get('userID');
206 $this->_isPermissionedChecksum
= FALSE;
207 $permissionType = CRM_Core_Permission
::VIEW
;
208 if ($this->_id
!= $userID) {
209 // do not allow edit for anon users in joomla frontend, CRM-4668, unless u have checksum CRM-5228
210 if ($config->userFrameworkFrontend
) {
211 $this->_isPermissionedChecksum
= CRM_Contact_BAO_Contact_Permission
::validateOnlyChecksum($this->_id
, $this, FALSE);
214 $this->_isPermissionedChecksum
= CRM_Contact_BAO_Contact_Permission
::validateChecksumContact($this->_id
, $this, FALSE);
218 // Users with create or edit permission should be allowed to view their own profile
219 if ($this->_id
== $userID ||
$this->_isPermissionedChecksum
) {
220 if (!CRM_Core_Permission
::check('profile view')) {
221 if (CRM_Core_Permission
::check('profile create') || CRM_Core_Permission
::check('profile edit')) {
222 $this->_skipPermission
= TRUE;
227 // make sure we dont expose all fields based on permission
229 if ((!$config->userFrameworkFrontend
&&
230 (CRM_Core_Permission
::check('administer users') ||
231 CRM_Core_Permission
::check('view all contacts') ||
232 CRM_Contact_BAO_Contact_Permission
::allow($this->_id
)
235 $this->_id
== $userID ||
236 $this->_isPermissionedChecksum
242 $fields = CRM_Core_BAO_UFGroup
::getFields($this->_profileIds
, FALSE, CRM_Core_Action
::VIEW
,
243 NULL, NULL, FALSE, $this->_restrict
,
244 $this->_skipPermission
, NULL,
248 if ($this->_multiRecord
& CRM_Core_Action
::VIEW
&& $this->_recordId
&& !$this->_allFields
) {
249 CRM_Core_BAO_UFGroup
::shiftMultiRecordFields($fields, $multiRecordFields);
250 $fields = $multiRecordFields;
252 if ($this->_isContactActivityProfile
&& $this->_gid
) {
253 $errors = CRM_Profile_Form
::validateContactActivityProfile($this->_activityId
, $this->_id
, $this->_gid
);
254 if (!empty($errors)) {
255 CRM_Core_Error
::fatal(array_pop($errors));
259 //reformat fields array
260 foreach ($fields as $name => $field) {
261 // also eliminate all formatting fields
262 if (CRM_Utils_Array
::value('field_type', $field) == 'Formatting') {
263 unset($fields[$name]);
266 // make sure that there is enough permission to expose this field
267 if (!$admin && $field['visibility'] == 'User and User Admin Only') {
268 unset($fields[$name]);
272 if ($this->_isContactActivityProfile
) {
273 $contactFields = $activityFields = array();
275 foreach ($fields as $fieldName => $field) {
276 if (CRM_Utils_Array
::value('field_type', $field) == 'Activity') {
277 $activityFields[$fieldName] = $field;
280 $contactFields[$fieldName] = $field;
284 CRM_Core_BAO_UFGroup
::getValues($this->_id
, $contactFields, $values);
285 if ($this->_activityId
) {
286 CRM_Core_BAO_UFGroup
::getValues(
291 array(array('activity_id', '=', $this->_activityId
, 0, 0))
296 $customWhereClause = NULL;
297 if ($this->_multiRecord
& CRM_Core_Action
::VIEW
&& $this->_recordId
) {
298 if ($this->_allFields
) {
299 $copyFields = $fields;
300 CRM_Core_BAO_UFGroup
::shiftMultiRecordFields($copyFields, $multiRecordFields);
301 $fieldKey = key($multiRecordFields);
304 $fieldKey = key($fields);
306 if ($fieldID = CRM_Core_BAO_CustomField
::getKeyID($fieldKey)) {
307 $tableColumnGroup = CRM_Core_BAO_CustomField
::getTableColumnGroup($fieldID);
308 $columnName = "{$tableColumnGroup[0]}.id";
309 $customWhereClause = $columnName . ' = ' . $this->_recordId
;
312 CRM_Core_BAO_UFGroup
::getValues($this->_id
, $fields, $values, TRUE, NULL, FALSE, $customWhereClause);
315 // $profileFields array can be used for customized display of field labels and values in Profile/View.tpl
316 $profileFields = array();
319 foreach ($fields as $name => $field) {
321 // Create a unique, non-empty index for each field.
322 $index = $field['title'];
326 while (array_key_exists($index, $labels)) {
330 $labels[$index] = preg_replace('/\s+|\W+/', '_', $name);
333 foreach ($values as $title => $value) {
334 $profileFields[$labels[$title]] = array(
340 $template->assign_by_ref('row', $values);
341 $template->assign_by_ref('profileFields', $profileFields);
344 $name = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid
, 'name');
345 $this->assign('ufGroupName', $name);
346 CRM_Utils_Hook
::viewProfile($name);
348 if (strtolower($name) == 'summary_overlay') {
349 $template->assign('overlayProfile', TRUE);
352 if (($this->_multiRecord
& CRM_Core_Action
::VIEW
) && $this->_recordId
&& !$this->_allFields
) {
353 $fieldDetail = reset($fields);
354 $fieldId = CRM_Core_BAO_CustomField
::getKeyID($fieldDetail['name']);
355 $customGroupDetails = CRM_Core_BAO_CustomGroup
::getGroupTitles(array($fieldId));
356 $multiRecTitle = $customGroupDetails[$fieldId]['groupTitle'];
359 $title = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid
, 'title');
363 $displayName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_id
, 'display_name');
365 $session = CRM_Core_Session
::singleton();
366 $config = CRM_Core_Config
::singleton();
367 if ($session->get('userID') &&
368 CRM_Core_Permission
::check('access CiviCRM') &&
369 CRM_Contact_BAO_Contact_Permission
::allow($session->get('userID'), CRM_Core_Permission
::VIEW
) &&
370 !$config->userFrameworkFrontend
372 $contactViewUrl = CRM_Utils_System
::url('civicrm/contact/view', "action=view&reset=1&cid={$this->_id}", TRUE);
373 $this->assign('displayName', $displayName);
374 $displayName = "<a href=\"$contactViewUrl\">{$displayName}</a>";
376 $title .= ' - ' . $displayName;
379 $title = isset($multiRecTitle) ?
ts('View %1 Record', array(1 => $multiRecTitle)) : $title;
380 CRM_Utils_System
::setTitle($title);
382 // invoke the pagRun hook, CRM-3906
383 CRM_Utils_Hook
::pageRun($this);
385 return trim($template->fetch($this->getHookedTemplateFileName()));
389 * @param string $suffix
391 * @return null|string
393 public function checkTemplateFileExists($suffix = '') {
395 $templateFile = "CRM/Profile/Page/{$this->_gid}/Dynamic.{$suffix}tpl";
396 $template = CRM_Core_Page
::getTemplate();
397 if ($template->template_exists($templateFile)) {
398 return $templateFile;
401 // lets see if we have customized by name
402 $ufGroupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid
, 'name');
404 $templateFile = "CRM/Profile/Page/{$ufGroupName}/Dynamic.{$suffix}tpl";
405 if ($template->template_exists($templateFile)) {
406 return $templateFile;
414 * Use the form name to create the tpl file name
421 public function getTemplateFileName() {
422 $fileName = $this->checkTemplateFileExists();
423 return $fileName ?
$fileName : parent
::getTemplateFileName();
427 * Default extra tpl file basically just replaces .tpl with .extra.tpl
428 * i.e. we dont override
435 public function overrideExtraTemplateFileName() {
436 $fileName = $this->checkTemplateFileExists('extra.');
437 return $fileName ?
$fileName : parent
::overrideExtraTemplateFileName();