CRM-14338-2 fix prefix/suffix on profile view page
[civicrm-core.git] / CRM / Profile / Page / Dynamic.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
232624b1 4 | CiviCRM version 4.4 |
6a488035
TO
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
32 * $Id$
33 *
34 */
35
36/**
37 * Create a page for displaying CiviCRM Profile Fields.
38 *
39 * Heart of this class is the run method which checks
40 * for action type and then displays the appropriate
41 * page.
42 *
43 */
44class CRM_Profile_Page_Dynamic extends CRM_Core_Page {
45
46 /**
47 * The contact id of the person we are viewing
48 *
49 * @var int
50 * @access protected
51 */
52 protected $_id;
53
54 /**
55 * the profile group are are interested in
56 *
57 * @var int
58 * @access protected
59 */
60 protected $_gid;
61
62 /**
63 * The profile types we restrict this page to display
64 *
65 * @var string
66 * @access protected
67 */
68 protected $_restrict;
69
70 /**
71 * Should we bypass permissions
72 *
73 * @var boolean
74 * @access protected
75 */
76 protected $_skipPermission;
77
78 /**
79 * Store profile ids if multiple profile ids are passed using comma separated.
80 * Currently lets implement this functionality only for dialog mode
81 */
82 protected $_profileIds = array();
83
84 /**
85 * Contact profile having activity fields?
86 *
87 * @var string
88 */
89 protected $_isContactActivityProfile = FALSE;
90
91 /**
92 * Activity Id connected to the profile
93 *
94 * @var string
95 */
96 protected $_activityId = NULL;
97
98 protected $_multiRecord = NULL;
99
100 protected $_recordId = NULL;
366fe2a3 101
6a488035
TO
102 /*
103 * fetch multirecord as well as non-multirecord fields
104 */
105 protected $_allFields = NULL;
106
107 /**
108 * class constructor
109 *
110 * @param int $id the contact id
111 * @param int $gid the group id
112 *
113 * @return void
114 * @access public
115 */
116 function __construct($id, $gid, $restrict, $skipPermission = FALSE, $profileIds = NULL) {
117 parent::__construct();
118
119 $this->_id = $id;
120 $this->_gid = $gid;
121 $this->_restrict = $restrict;
122 $this->_skipPermission = $skipPermission;
123
124 if (!array_key_exists('multiRecord', $_GET)) {
125 $this->set('multiRecord', NULL);
126 }
127 if (!array_key_exists('recordId', $_GET)) {
128 $this->set('recordId', NULL);
129 }
130 if (!array_key_exists('allFields', $_GET)) {
131 $this->set('allFields', NULL);
132 }
366fe2a3 133
6a488035
TO
134 //specifies the action being done on a multi record field
135 $multiRecordAction = CRM_Utils_Request::retrieve('multiRecord', 'String', $this);
366fe2a3 136
137 $this->_multiRecord = (!is_numeric($multiRecordAction)) ?
6a488035
TO
138 CRM_Core_Action::resolve($multiRecordAction) : $multiRecordAction;
139 if ($this->_multiRecord) {
140 $this->set('multiRecord', $this->_multiRecord);
141 }
366fe2a3 142
6a488035
TO
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);
146 }
366fe2a3 147
6a488035
TO
148 if ($profileIds) {
149 $this->_profileIds = $profileIds;
150 }
151 else {
152 $this->_profileIds = array($gid);
153 }
154
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;
160 }
161 }
162 $this->_isContactActivityProfile = CRM_Core_BAO_UFField::checkContactActivityProfileType($this->_gid);
163 }
164
165 /**
166 * Get the action links for this page.
167 *
168 * @return array $_actionLinks
169 *
170 */
171 function &actionLinks() {
172 return NULL;
173 }
174
175 /**
176 * Run the page.
177 *
178 * This method is called after the page is created. It checks for the
179 * type of action and executes that action.
180 *
181 * @return void
182 * @access public
183 *
184 */
185 function run() {
186 $template = CRM_Core_Smarty::singleton();
187 if ($this->_id && $this->_gid) {
188
189 // first check that id is part of the limit group id, CRM-4822
190 $limitListingsGroupsID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup',
191 $this->_gid,
192 'limit_listings_group_id'
193 );
194 $config = CRM_Core_Config::singleton();
195 if ($limitListingsGroupsID) {
196
197 if (!CRM_Contact_BAO_GroupContact::isContactInGroup($this->_id,
198 $limitListingsGroupsID
199 )) {
200 CRM_Utils_System::setTitle(ts('Profile View - Permission Denied'));
201 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');
202 }
203 }
204
205 $session = CRM_Core_Session::singleton();
206 $userID = $session->get('userID');
207
208 $this->_isPermissionedChecksum = FALSE;
209 $permissionType = CRM_Core_Permission::VIEW;
210 if ($this->_id != $userID) {
211 // do not allow edit for anon users in joomla frontend, CRM-4668, unless u have checksum CRM-5228
212 if ($config->userFrameworkFrontend) {
213 $this->_isPermissionedChecksum = CRM_Contact_BAO_Contact_Permission::validateOnlyChecksum($this->_id, $this, FALSE);
214 }
215 else {
216 $this->_isPermissionedChecksum = CRM_Contact_BAO_Contact_Permission::validateChecksumContact($this->_id, $this, FALSE);
217 }
218 }
219 // CRM-10853
220 // Users with create or edit permission should be allowed to view their own profile
221 if ($this->_id == $userID || $this->_isPermissionedChecksum) {
222 if (!CRM_Core_Permission::check('profile view')) {
223 if (CRM_Core_Permission::check('profile create') || CRM_Core_Permission::check('profile edit')) {
224 $this->_skipPermission = TRUE;
225 }
226 }
227 }
228
229 // make sure we dont expose all fields based on permission
230 $admin = FALSE;
231 if ((!$config->userFrameworkFrontend &&
232 (CRM_Core_Permission::check('administer users') ||
233 CRM_Core_Permission::check('view all contacts') ||
234 CRM_Contact_BAO_Contact_Permission::allow($this->_id)
235 )
236 ) ||
237 $this->_id == $userID ||
238 $this->_isPermissionedChecksum
239 ) {
240 $admin = TRUE;
241 }
242
243 $values = array();
244 $fields = CRM_Core_BAO_UFGroup::getFields($this->_profileIds, FALSE, CRM_Core_Action::VIEW,
245 NULL, NULL, FALSE, $this->_restrict,
246 $this->_skipPermission, NULL,
247 $permissionType
248 );
249
250 if ($this->_multiRecord & CRM_Core_Action::VIEW && $this->_recordId && !$this->_allFields) {
251 CRM_Core_BAO_UFGroup::shiftMultiRecordFields($fields, $multiRecordFields);
252 $fields = $multiRecordFields;
253 }
254 if ($this->_isContactActivityProfile && $this->_gid) {
255 $errors = CRM_Profile_Form::validateContactActivityProfile($this->_activityId, $this->_id, $this->_gid);
256 if (!empty($errors)) {
257 CRM_Core_Error::fatal(array_pop($errors));
258 }
259 }
260
261 //reformat fields array
262 foreach ($fields as $name => $field) {
263 // also eliminate all formatting fields
264 if (CRM_Utils_Array::value('field_type', $field) == 'Formatting') {
265 unset($fields[$name]);
266 }
267
268 // make sure that there is enough permission to expose this field
269 if (!$admin && $field['visibility'] == 'User and User Admin Only') {
270 unset($fields[$name]);
271 }
272 }
273
274 if ($this->_isContactActivityProfile) {
275 $contactFields = $activityFields = array();
276
277 foreach ($fields as $fieldName => $field) {
278 if (CRM_Utils_Array::value('field_type', $field) == 'Activity') {
279 $activityFields[$fieldName] = $field;
280 }
281 else {
282 $contactFields[$fieldName] = $field;
283 }
284 }
285
286 CRM_Core_BAO_UFGroup::getValues($this->_id, $contactFields, $values);
287 if ($this->_activityId) {
288 CRM_Core_BAO_UFGroup::getValues(
289 NULL,
290 $activityFields,
291 $values,
292 TRUE,
293 array(array('activity_id', '=', $this->_activityId, 0, 0))
294 );
295 }
296 }
297 else {
298 $customWhereClause = NULL;
299 if ($this->_multiRecord & CRM_Core_Action::VIEW && $this->_recordId) {
300 if ($this->_allFields) {
301 $copyFields = $fields;
302 CRM_Core_BAO_UFGroup::shiftMultiRecordFields($copyFields, $multiRecordFields);
303 $fieldKey = key($multiRecordFields);
304 } else {
305 $fieldKey = key($fields);
306 }
307 if ($fieldID = CRM_Core_BAO_CustomField::getKeyID($fieldKey)) {
308 $tableColumnGroup = CRM_Core_BAO_CustomField::getTableColumnGroup($fieldID);
309 $columnName = "{$tableColumnGroup[0]}.id";
310 $customWhereClause = $columnName . ' = ' . $this->_recordId;
311 }
312 }
313 CRM_Core_BAO_UFGroup::getValues($this->_id, $fields, $values, TRUE, NULL, FALSE, $customWhereClause);
314 }
315
316 // $profileFields array can be used for customized display of field labels and values in Profile/View.tpl
317 $profileFields = array();
318 $labels = array();
319
46796b19
BS
320 //CRM-14338
321 $nullValueIndex = ' ';
6a488035 322 foreach ($fields as $name => $field) {
46796b19
BS
323 if ( isset($labels[$field['title']]) ) {
324 $labels[$field['title'].$nullValueIndex] = preg_replace('/\s+|\W+/', '_', $name);
325 $nullValueIndex .= $nullValueIndex;
326 }
327 else {
328 $labels[$field['title']] = preg_replace('/\s+|\W+/', '_', $name);
329 }
6a488035
TO
330 }
331
332 foreach ($values as $title => $value) {
333 $profileFields[$labels[$title]] = array(
334 'label' => $title,
335 'value' => $value,
336 );
337 }
338
339 $template->assign_by_ref('row', $values);
340 $template->assign_by_ref('profileFields', $profileFields);
341 }
342
343 $name = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid, 'name');
46312a4d 344 $this->assign('ufGroupName', $name);
a8387f19 345 CRM_Utils_Hook::viewProfile($name);
6a488035
TO
346
347 if (strtolower($name) == 'summary_overlay') {
348 $template->assign('overlayProfile', TRUE);
349 }
350
351 if (($this->_multiRecord & CRM_Core_Action::VIEW) && $this->_recordId && !$this->_allFields) {
352 $fieldDetail = reset($fields);
353 $fieldId = CRM_Core_BAO_CustomField::getKeyID($fieldDetail['name']);
354 $customGroupDetails = CRM_Core_BAO_CustomGroup::getGroupTitles(array($fieldId));
355 $title = $customGroupDetails[$fieldId]['groupTitle'];
356 } else {
357 $title = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid, 'title');
358 }
359
360 //CRM-4131.
361 $displayName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_id, 'display_name');
362 if ($displayName) {
363 $session = CRM_Core_Session::singleton();
364 $config = CRM_Core_Config::singleton();
365 if ($session->get('userID') &&
366 CRM_Core_Permission::check('access CiviCRM') &&
367 CRM_Contact_BAO_Contact_Permission::allow($session->get('userID'), CRM_Core_Permission::VIEW) &&
368 !$config->userFrameworkFrontend
369 ) {
370 $contactViewUrl = CRM_Utils_System::url('civicrm/contact/view', "action=view&reset=1&cid={$this->_id}", TRUE);
371 $this->assign('displayName', $displayName);
372 $displayName = "<a href=\"$contactViewUrl\">{$displayName}</a>";
373 }
374 $title .= ' - ' . $displayName;
375 }
376
377 CRM_Utils_System::setTitle($title);
378
379 // invoke the pagRun hook, CRM-3906
380 CRM_Utils_Hook::pageRun($this);
381
8aac22c8 382 return trim($template->fetch($this->getHookedTemplateFileName()));
6a488035
TO
383 }
384
385 function checkTemplateFileExists($suffix = '') {
386 if ($this->_gid) {
387 $templateFile = "CRM/Profile/Page/{$this->_gid}/Dynamic.{$suffix}tpl";
388 $template = CRM_Core_Page::getTemplate();
389 if ($template->template_exists($templateFile)) {
390 return $templateFile;
391 }
392
393 // lets see if we have customized by name
394 $ufGroupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid, 'name');
395 if ($ufGroupName) {
396 $templateFile = "CRM/Profile/Page/{$ufGroupName}/Dynamic.{$suffix}tpl";
397 if ($template->template_exists($templateFile)) {
398 return $templateFile;
399 }
400 }
401 }
402 return NULL;
403 }
404
405 function getTemplateFileName() {
406 $fileName = $this->checkTemplateFileExists();
407 return $fileName ? $fileName : parent::getTemplateFileName();
408 }
409
410 function overrideExtraTemplateFileName() {
411 $fileName = $this->checkTemplateFileExists('extra.');
412 return $fileName ? $fileName : parent::overrideExtraTemplateFileName();
413 }
414}
415