Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.3 | | |
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 | * 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'), | |
161 | 'url' => $path, | |
162 | ))); | |
163 | CRM_Utils_System::appendBreadCrumb(array(array('title' => ts('Search Results'), | |
164 | 'url' => self::getSearchURL(), | |
165 | ))); | |
166 | ||
167 | if ($image_URL = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId, 'image_URL')) { | |
168 | ||
169 | //CRM-7265 --time being fix. | |
170 | $config = CRM_Core_Config::singleton(); | |
171 | $image_URL = str_replace('https://', 'http://', $image_URL); | |
172 | if (CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'enableSSL')) { | |
173 | $image_URL = str_replace('http://', 'https://', $image_URL); | |
174 | } | |
175 | ||
176 | list($imageWidth, $imageHeight) = getimagesize($image_URL); | |
177 | list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact::getThumbSize($imageWidth, $imageHeight); | |
178 | $this->assign("imageWidth", $imageWidth); | |
179 | $this->assign("imageHeight", $imageHeight); | |
180 | $this->assign("imageThumbWidth", $imageThumbWidth); | |
181 | $this->assign("imageThumbHeight", $imageThumbHeight); | |
182 | $this->assign("imageURL", $image_URL); | |
183 | } | |
184 | ||
185 | // also store in session for future use | |
186 | $session = CRM_Core_Session::singleton(); | |
187 | $session->set('view.id', $this->_contactId); | |
188 | ||
189 | $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse'); | |
190 | $this->assign('action', $this->_action); | |
191 | ||
192 | // check logged in user permission | |
193 | self::checkUserPermission($this); | |
194 | ||
195 | list($displayName, $contactImage, | |
196 | $contactType, $contactSubtype, $contactImageUrl | |
197 | ) = self::getContactDetails($this->_contactId); | |
198 | $this->assign('displayName', $displayName); | |
199 | ||
200 | $this->set('contactType', $contactType); | |
201 | $this->set('contactSubtype', $contactSubtype); | |
202 | ||
203 | // add to recently viewed block | |
204 | $isDeleted = (bool) CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId, 'is_deleted'); | |
205 | ||
206 | $recentOther = array( | |
207 | 'imageUrl' => $contactImageUrl, | |
208 | 'subtype' => $contactSubtype, | |
209 | 'isDeleted' => $isDeleted, | |
210 | ); | |
211 | ||
212 | if (($session->get('userID') == $this->_contactId) || | |
213 | CRM_Contact_BAO_Contact_Permission::allow($this->_contactId, CRM_Core_Permission::EDIT) | |
214 | ) { | |
215 | $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/add', "reset=1&action=update&cid={$this->_contactId}"); | |
216 | } | |
217 | ||
218 | if (($session->get('userID') != $this->_contactId) && CRM_Core_Permission::check('delete contacts') | |
219 | && !$isDeleted | |
220 | ) { | |
221 | $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/delete', "reset=1&delete=1&cid={$this->_contactId}"); | |
222 | } | |
223 | ||
224 | CRM_Utils_Recent::add($displayName, | |
225 | CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$this->_contactId}"), | |
226 | $this->_contactId, | |
227 | $contactType, | |
228 | $this->_contactId, | |
229 | $displayName, | |
230 | $recentOther | |
231 | ); | |
232 | $this->assign('isDeleted', $isDeleted); | |
233 | ||
234 | // set page title | |
235 | $title = self::setTitle($this->_contactId, $isDeleted); | |
236 | $this->assign('title', $title); | |
237 | ||
238 | // Check if this is default domain contact CRM-10482 | |
239 | if (CRM_Contact_BAO_Contact::checkDomainContact($this->_contactId)) { | |
240 | $this->assign('domainContact', TRUE); | |
241 | } else { | |
242 | $this->assign('domainContact', FALSE); | |
243 | } | |
244 | ||
245 | // Add links for actions menu | |
246 | self::addUrls($this, $this->_contactId); | |
247 | ||
248 | if ($contactType == 'Organization' && | |
249 | CRM_Core_Permission::check('administer Multiple Organizations') && | |
250 | CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MULTISITE_PREFERENCES_NAME, | |
251 | 'is_enabled' | |
252 | ) | |
253 | ) { | |
254 | //check is any relationship between the organization and groups | |
255 | $groupOrg = CRM_Contact_BAO_GroupOrganization::hasGroupAssociated($this->_contactId); | |
256 | if ($groupOrg) { | |
257 | $groupOrganizationUrl = CRM_Utils_System::url('civicrm/group', | |
258 | "reset=1&oid={$this->_contactId}" | |
259 | ); | |
260 | $this->assign('groupOrganizationUrl', $groupOrganizationUrl); | |
261 | } | |
262 | } | |
263 | } | |
264 | ||
265 | /** | |
266 | * Get meta details of the contact. | |
267 | * | |
268 | * @return array contact fields in fixed order | |
269 | * @access public | |
270 | */ | |
271 | static function getContactDetails($contactId) { | |
272 | return list($displayName, | |
273 | $contactImage, | |
274 | $contactType, | |
275 | $contactSubtype, | |
276 | $contactImageUrl | |
277 | ) = CRM_Contact_BAO_Contact::getDisplayAndImage($contactId, | |
278 | TRUE, | |
279 | TRUE | |
280 | ); | |
281 | } | |
282 | ||
283 | function getSearchURL() { | |
284 | $qfKey = CRM_Utils_Request::retrieve('key', 'String', $this); | |
285 | $context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'search'); | |
286 | $this->assign('context', $context); | |
287 | ||
288 | //validate the qfKey | |
289 | if (!CRM_Utils_Rule::qfKey($qfKey)) { | |
290 | $qfKey = NULL; | |
291 | } | |
292 | ||
293 | $urlString = NULL; | |
294 | $urlParams = 'force=1'; | |
295 | ||
296 | switch ($context) { | |
297 | case 'custom': | |
298 | $urlString = 'civicrm/contact/search/custom'; | |
299 | break; | |
300 | ||
301 | case 'fulltext': | |
302 | $urlString = 'civicrm/contact/search/custom'; | |
303 | if ( $qfKey ) { | |
304 | $urlParams = '_qf_Custom_display=true'; | |
305 | } | |
306 | break; | |
307 | ||
308 | case 'advanced': | |
309 | $urlString = 'civicrm/contact/search/advanced'; | |
310 | break; | |
311 | ||
312 | case 'builder': | |
313 | $urlString = 'civicrm/contact/search/builder'; | |
314 | break; | |
315 | ||
316 | case 'basic': | |
317 | $urlString = 'civicrm/contact/search/basic'; | |
318 | break; | |
319 | ||
320 | case 'search': | |
321 | $urlString = 'civicrm/contact/search'; | |
322 | break; | |
323 | ||
324 | case 'smog': | |
325 | case 'amtg': | |
326 | $urlString = 'civicrm/group/search'; | |
327 | break; | |
328 | } | |
329 | if ($qfKey) { | |
330 | $urlParams .= "&qfKey=$qfKey"; | |
331 | } | |
332 | if (!$urlString) { | |
333 | $urlString = 'civicrm/contact/search/basic'; | |
334 | } | |
335 | ||
336 | return CRM_Utils_System::url($urlString, $urlParams); | |
337 | } | |
338 | ||
339 | static function checkUserPermission($page, $contactID = NULL) { | |
340 | // check for permissions | |
341 | $page->_permission = NULL; | |
342 | ||
343 | if (!$contactID) { | |
344 | $contactID = $page->_contactId; | |
345 | } | |
346 | ||
347 | // automatically grant permissin for users on their own record. makes | |
348 | // things easier in dashboard | |
349 | $session = CRM_Core_Session::singleton(); | |
350 | ||
351 | if ($session->get('userID') == $contactID) { | |
352 | $page->assign('permission', 'edit'); | |
353 | $page->_permission = CRM_Core_Permission::EDIT; | |
354 | // deleted contacts’ stuff should be (at best) only viewable | |
355 | } | |
356 | elseif (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'is_deleted') and CRM_Core_Permission::check('access deleted contacts')) { | |
357 | $page->assign('permission', 'view'); | |
358 | $page->_permission = CRM_Core_Permission::VIEW; | |
359 | } | |
360 | elseif (CRM_Contact_BAO_Contact_Permission::allow($contactID, CRM_Core_Permission::EDIT)) { | |
361 | $page->assign('permission', 'edit'); | |
362 | $page->_permission = CRM_Core_Permission::EDIT; | |
363 | } | |
364 | elseif (CRM_Contact_BAO_Contact_Permission::allow($contactID, CRM_Core_Permission::VIEW)) { | |
365 | $page->assign('permission', 'view'); | |
366 | $page->_permission = CRM_Core_Permission::VIEW; | |
367 | } | |
368 | else { | |
369 | $session->pushUserContext(CRM_Utils_System::url('civicrm', 'reset=1')); | |
370 | CRM_Core_Error::statusBounce(ts('You do not have the necessary permission to view this contact.')); | |
371 | } | |
372 | } | |
373 | ||
374 | static function setTitle($contactId, $isDeleted = FALSE) { | |
375 | static $contactDetails; | |
376 | $displayName = $contactImage = NULL; | |
377 | if (!isset($contactDetails[$contactId])) { | |
378 | list($displayName, $contactImage) = self::getContactDetails($contactId); | |
379 | $contactDetails[$contactId] = array( | |
380 | 'displayName' => $displayName, | |
381 | 'contactImage' => $contactImage, | |
382 | ); | |
383 | } | |
384 | else { | |
385 | $displayName = $contactDetails[$contactId]['displayName']; | |
386 | $contactImage = $contactDetails[$contactId]['contactImage']; | |
387 | } | |
388 | ||
389 | // set page title | |
390 | $title = "{$contactImage} {$displayName}"; | |
391 | if ($isDeleted) { | |
392 | $title = "<del>{$title}</del>"; | |
393 | } | |
394 | ||
395 | // Inline-edit places its own title on the page | |
396 | CRM_Utils_System::setTitle('CiviCRM', '<span id="crm-remove-title" style="display:none">CiviCRM</span>'); | |
397 | ||
398 | return $title; | |
399 | } | |
400 | ||
401 | /** | |
402 | * Add urls for display in the actions menu | |
403 | */ | |
404 | static function addUrls(&$obj, $cid) { | |
405 | $config = CRM_Core_Config::singleton(); | |
406 | $session = CRM_Core_Session::singleton(); | |
407 | $uid = CRM_Core_BAO_UFMatch::getUFId($cid); | |
408 | if ($uid) { | |
409 | // To do: we should also allow drupal users with CRM_Core_Permission::check( 'view user profiles' ) true to access $userRecordUrl | |
410 | // but this is currently returning false regardless of permission set for the role. dgg | |
411 | if ($config->userSystem->is_drupal == '1' && | |
412 | ($session->get('userID') == $cid || CRM_Core_Permission::check('administer users')) | |
413 | ) { | |
414 | $userRecordUrl = CRM_Utils_System::url('user/' . $uid); | |
415 | } | |
416 | elseif ($config->userFramework == 'Joomla') { | |
417 | $userRecordUrl = NULL; | |
418 | // if logged in user is super user, then he can view other users joomla profile | |
419 | if (JFactory::getUser()->authorise('core.admin')) { | |
420 | $userRecordUrl = $config->userFrameworkBaseURL . "index.php?option=com_users&view=user&task=user.edit&id=" . $uid; | |
421 | } | |
422 | elseif ($session->get('userID') == $cid) { | |
423 | $userRecordUrl = $config->userFrameworkBaseURL . "index.php?option=com_admin&view=profile&layout=edit&id=" . $uid; | |
424 | } | |
425 | } | |
426 | else { | |
427 | $userRecordUrl = NULL; | |
428 | } | |
429 | $obj->assign('userRecordUrl', $userRecordUrl); | |
430 | $obj->assign('userRecordId', $uid); | |
431 | } | |
432 | elseif (($config->userSystem->is_drupal == '1' && CRM_Core_Permission::check('administer users')) || | |
433 | ($config->userFramework == 'Joomla' && | |
434 | JFactory::getUser()->authorise('core.create', 'com_users') | |
435 | ) | |
436 | ) { | |
437 | $userAddUrl = CRM_Utils_System::url('civicrm/contact/view/useradd', | |
438 | 'reset=1&action=add&cid=' . $cid | |
439 | ); | |
440 | $obj->assign('userAddUrl', $userAddUrl); | |
441 | } | |
442 | ||
443 | if (CRM_Core_Permission::check('access Contact Dashboard')) { | |
444 | $dashboardURL = CRM_Utils_System::url('civicrm/user', | |
445 | "reset=1&id={$cid}" | |
446 | ); | |
447 | $obj->assign('dashboardURL', $dashboardURL); | |
448 | } | |
449 | ||
450 | // See if other modules want to add links to the activtity bar | |
451 | $hookLinks = CRM_Utils_Hook::links('view.contact.activity', | |
452 | 'Contact', | |
453 | $cid, | |
454 | CRM_Core_DAO::$_nullObject, | |
455 | CRM_Core_DAO::$_nullObject | |
456 | ); | |
457 | if (is_array($hookLinks)) { | |
458 | $obj->assign('hookLinks', $hookLinks); | |
459 | } | |
460 | } | |
461 | } | |
462 |