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 * Class contains Contact dashboard related functions
39 class CRM_Core_BAO_Dashboard
extends CRM_Core_DAO_Dashboard
{
43 * @param array $params
49 public static function create($params) {
50 $hook = empty($params['id']) ?
'create' : 'edit';
51 CRM_Utils_Hook
::pre($hook, 'Dashboard', CRM_Utils_Array
::value('id', $params), $params);
52 $dao = self
::addDashlet($params);
53 CRM_Utils_Hook
::post($hook, 'Dashboard', $dao->id
, $dao);
58 * Get the list of dashlets enabled by admin.
62 * @param bool $checkPermission
63 * All or only authorized for the current user.
68 public static function getDashlets($all = TRUE, $checkPermission = TRUE) {
70 $dao = new CRM_Core_DAO_Dashboard();
76 $dao->domain_id
= CRM_Core_Config
::domainID();
79 while ($dao->fetch()) {
80 if ($checkPermission && !self
::checkPermission($dao->permission
, $dao->permission_operator
)) {
85 CRM_Core_DAO
::storeValues($dao, $values);
86 $dashlets[$dao->id
] = $values;
93 * Get the list of dashlets for the current user or the specified user.
95 * Additionlly, initializes the dashboard with defaults if this is the
96 * user's first visit to their dashboard.
98 * @param bool $flatFormat
99 * This is true if you want simple associated.
100 * array of all the contact's dashlets whether or not they are enabled.
102 * @param int $contactID
103 * Provide the dashlets for the contact id.
104 * passed rather than the current user.
109 public static function getContactDashlets($flatFormat = FALSE, $contactID = NULL) {
113 $contactID = CRM_Core_Session
::singleton()->get('userID');
116 // Get contact dashboard dashlets.
117 $hasDashlets = FALSE;
118 $dao = new CRM_Contact_DAO_DashboardContact();
119 $dao->contact_id
= $contactID;
120 $dao->orderBy('column_no asc, weight asc');
122 while ($dao->fetch()) {
123 // When a dashlet is removed, it stays in the table with status disabled,
124 // so even if a user decides not to have any dashlets show, they will still
125 // have records in the table to indicate that we are not newly initializing.
128 if ($dao->is_active
) {
129 // append weight so that order is preserved.
130 $dashlets[$dao->column_no
]["{$dao->weight}-{$dao->dashboard_id}"] = $dao->is_minimized
;
134 $dashlets[$dao->dashboard_id
] = $dao->dashboard_id
;
142 // If empty, then initialize contact dashboard for this user.
144 return self
::initializeDashlets($flatFormat);
150 * Setup default dashlets for new users.
152 * When a user accesses their dashboard for the first time, set up
153 * the default dashlets.
156 * Array of dashboard_id's
158 public static function initializeDashlets($flatFormat = FALSE) {
160 $getDashlets = civicrm_api3("Dashboard", "get", array(
161 'domain_id' => CRM_Core_Config
::domainID(),
164 $contactID = CRM_Core_Session
::singleton()->get('userID');
165 $allDashlets = CRM_Utils_Array
::index(array('name'), $getDashlets['values']);
166 $defaultDashlets = array();
167 if (!empty($allDashlets['blog'])) {
168 $defaultDashlets['blog'] = array(
169 'dashboard_id' => $allDashlets['blog']['id'],
172 'contact_id' => $contactID,
175 CRM_Utils_Hook
::dashboard_defaults($allDashlets, $defaultDashlets);
176 if (is_array($defaultDashlets) && !empty($defaultDashlets)) {
177 foreach ($defaultDashlets as $id => $defaultDashlet) {
178 $dashboard_id = $defaultDashlet['dashboard_id'];
179 if (!self
::checkPermission($getDashlets['values'][$dashboard_id]['permission'],
180 $getDashlets['values'][$dashboard_id]['permission_operator'])
185 $assignDashlets = civicrm_api3("dashboard_contact", "create", $defaultDashlet);
187 $values = $assignDashlets['values'][$assignDashlets['id']];
188 $dashlets[$values['column_no']][$values['weight'] - $values['dashboard_id']] = $values['is_minimized'];
191 $dashlets[$dashboard_id] = $defaultDashlet['dashboard_id'];
201 * Check dashlet permission for current user.
203 * @param string $permission
204 * Comma separated list.
205 * @param string $operator
208 * true if use has permission else false
210 public static function checkPermission($permission, $operator) {
212 $permissions = explode(',', $permission);
213 $config = CRM_Core_Config
::singleton();
215 static $allComponents;
216 if (!$allComponents) {
217 $allComponents = CRM_Core_Component
::getNames();
220 $hasPermission = FALSE;
221 foreach ($permissions as $key) {
224 $componentName = NULL;
225 if (strpos($key, 'access') === 0) {
226 $componentName = trim(substr($key, 6));
227 if (!in_array($componentName, $allComponents)) {
228 $componentName = NULL;
232 // hack to handle case permissions
233 if (!$componentName && in_array($key, array(
234 'access my cases and activities',
235 'access all cases and activities',
238 $componentName = 'CiviCase';
241 //hack to determine if it's a component related permission
242 if ($componentName) {
243 if (!in_array($componentName, $config->enableComponents
) ||
244 !CRM_Core_Permission
::check($key)
246 $showDashlet = FALSE;
247 if ($operator == 'AND') {
252 $hasPermission = TRUE;
255 elseif (!CRM_Core_Permission
::check($key)) {
256 $showDashlet = FALSE;
257 if ($operator == 'AND') {
262 $hasPermission = TRUE;
266 if (!$showDashlet && !$hasPermission) {
274 // if permission is not set consider everyone has permission to access it.
280 * Get details of each dashlets.
282 * @param int $dashletID
286 * associted array title and content
288 public static function getDashletInfo($dashletID) {
289 $dashletInfo = array();
291 $params = array(1 => array($dashletID, 'Integer'));
292 $query = "SELECT name, label, url, fullscreen_url, is_fullscreen FROM civicrm_dashboard WHERE id = %1";
293 $dashboadDAO = CRM_Core_DAO
::executeQuery($query, $params);
294 $dashboadDAO->fetch();
297 $dao = new CRM_Contact_DAO_DashboardContact();
299 $session = CRM_Core_Session
::singleton();
300 $dao->contact_id
= $session->get('userID');
301 $dao->dashboard_id
= $dashletID;
304 //reset content based on the cache time set in config
305 $createdDate = strtotime($dao->created_date
);
306 $dateDiff = round(abs(time() - $createdDate) / 60);
308 $config = CRM_Core_Config
::singleton();
309 if ($config->dashboardCacheTimeout
<= $dateDiff) {
310 $dao->content
= NULL;
313 // if content is empty and url is set, retrieve it from url
314 if (!$dao->content
&& $dashboadDAO->url
) {
315 $url = $dashboadDAO->url
;
318 // -lets use relative url for internal use.
319 // -make sure relative url should not be htmlize.
320 if (substr($dashboadDAO->url
, 0, 4) != 'http') {
321 $urlParam = explode('?', $dashboadDAO->url
);
322 $url = CRM_Utils_System
::url($urlParam[0], $urlParam[1], TRUE, NULL, FALSE);
325 //get content from url
326 $dao->content
= CRM_Utils_System
::getServerResponse($url);
327 $dao->created_date
= date("YmdHis");
331 $dashletInfo = array(
332 'title' => $dashboadDAO->label
,
333 'name' => $dashboadDAO->name
,
334 'content' => $dao->content
,
337 if ($dashboadDAO->is_fullscreen
) {
338 $fullscreenUrl = $dashboadDAO->fullscreen_url
;
339 if (substr($fullscreenUrl, 0, 4) != 'http') {
340 $urlParam = explode('?', $dashboadDAO->fullscreen_url
);
341 $fullscreenUrl = CRM_Utils_System
::url($urlParam[0], $urlParam[1], TRUE, NULL, FALSE);
343 $dashletInfo['fullscreenUrl'] = $fullscreenUrl;
349 * Save changes made by use to the Dashlet.
351 * @param array $columns
353 * @param int $contactID
355 * @throws RuntimeException
358 public static function saveDashletChanges($columns, $contactID = NULL) {
359 $session = CRM_Core_Session
::singleton();
361 $contactID = $session->get('userID');
364 if (empty($contactID)) {
365 throw new RuntimeException("Failed to determine contact ID");
368 //we need to get existing dashlets, so we know when to update or insert
369 $contactDashlets = self
::getContactDashlets(TRUE, $contactID);
371 $dashletIDs = array();
372 if (is_array($columns)) {
373 foreach ($columns as $colNo => $dashlets) {
374 if (!is_int($colNo)) {
378 foreach ($dashlets as $dashletID => $isMinimized) {
379 $isMinimized = (int) $isMinimized;
380 if (in_array($dashletID, $contactDashlets)) {
381 $query = " UPDATE civicrm_dashboard_contact
382 SET weight = {$weight}, is_minimized = {$isMinimized}, column_no = {$colNo}, is_active = 1
383 WHERE dashboard_id = {$dashletID} AND contact_id = {$contactID} ";
386 $query = " INSERT INTO civicrm_dashboard_contact
387 ( weight, is_minimized, column_no, is_active, dashboard_id, contact_id )
388 VALUES( {$weight}, {$isMinimized}, {$colNo}, 1, {$dashletID}, {$contactID} )";
390 // fire update query for each column
391 $dao = CRM_Core_DAO
::executeQuery($query);
393 $dashletIDs[] = $dashletID;
399 if (!empty($dashletIDs)) {
400 // we need to disable widget that removed
401 $updateQuery = " UPDATE civicrm_dashboard_contact
403 WHERE dashboard_id NOT IN ( " . implode(',', $dashletIDs) . ") AND contact_id = {$contactID}";
406 // this means all widgets are disabled
407 $updateQuery = " UPDATE civicrm_dashboard_contact
409 WHERE contact_id = {$contactID}";
412 CRM_Core_DAO
::executeQuery($updateQuery);
418 * @param array $params
421 * $dashlet returns dashlet object
423 public static function addDashlet(&$params) {
425 // special case to handle duplicate entries for report instances
426 $dashboardID = CRM_Utils_Array
::value('id', $params);
428 if (!empty($params['instanceURL'])) {
430 FROM `civicrm_dashboard`
431 WHERE url LIKE '" . CRM_Utils_Array
::value('instanceURL', $params) . "&%'";
432 $dashboardID = CRM_Core_DAO
::singleValueQuery($query);
435 $dashlet = new CRM_Core_DAO_Dashboard();
438 // check url is same as exiting entries, if yes just update existing
439 if (!empty($params['name'])) {
440 $dashlet->name
= CRM_Utils_Array
::value('name', $params);
441 $dashlet->find(TRUE);
444 $dashlet->url
= CRM_Utils_Array
::value('url', $params);
445 $dashlet->find(TRUE);
447 if (empty($params['domain_id'])) {
448 $dashlet->domain_id
= CRM_Core_Config
::domainID();
452 $dashlet->id
= $dashboardID;
455 if (is_array(CRM_Utils_Array
::value('permission', $params))) {
456 $params['permission'] = implode(',', $params['permission']);
458 $dashlet->copyValues($params);
461 // now we need to make dashlet entries for each contact
462 self
::addContactDashlet($dashlet);
472 public static function getDashletName($url) {
473 $urlElements = explode('/', $url);
474 if ($urlElements[1] == 'dashlet') {
475 return $urlElements[2];
477 elseif ($urlElements[1] == 'report') {
478 return 'report/' . $urlElements[3];
484 * Update contact dashboard with new dashlet.
486 * @param object : $dashlet
490 public static function addContactDashlet($dashlet) {
491 $admin = CRM_Core_Permission
::check('administer CiviCRM');
493 // if dashlet is created by admin then you need to add it all contacts.
494 // else just add to contact who is creating this dashlet
495 $contactIDs = array();
497 $query = "SELECT distinct( contact_id )
498 FROM civicrm_dashboard_contact
499 WHERE contact_id NOT IN (
500 SELECT distinct( contact_id )
501 FROM civicrm_dashboard_contact WHERE dashboard_id = {$dashlet->id}
504 $dao = CRM_Core_DAO
::executeQuery($query);
505 while ($dao->fetch()) {
506 $contactIDs[] = $dao->contact_id
;
510 //Get the id of Logged in User
511 $session = CRM_Core_Session
::singleton();
512 $contactID = $session->get('userID');
513 if (!empty($contactID)) {
514 $contactIDs[] = $session->get('userID');
518 if (!empty($contactIDs)) {
519 foreach ($contactIDs as $contactID) {
520 $valuesArray[] = " ( {$dashlet->id}, {$contactID} )";
523 $valuesString = implode(',', $valuesArray);
525 INSERT INTO civicrm_dashboard_contact ( dashboard_id, contact_id )
526 VALUES {$valuesString}";
528 CRM_Core_DAO
::executeQuery($query);
533 * @param array $params
534 * Each item is a spec for a dashlet on the contact's dashboard.
537 public static function addContactDashletToDashboard(&$params) {
538 $valuesString = NULL;
540 foreach ($params as $dashboardIDs) {
541 $contactID = CRM_Utils_Array
::value('contact_id', $dashboardIDs);
542 $dashboardID = CRM_Utils_Array
::value('dashboard_id', $dashboardIDs);
543 $column = CRM_Utils_Array
::value('column_no', $dashboardIDs, 0);
544 $columns[$column][$dashboardID] = 0;
546 self
::saveDashletChanges($columns, $contactID);
551 * Reset dashlet cache.
553 * @param int $contactID
554 * Reset cache only for specific contact.
558 public static function resetDashletCache($contactID = NULL) {
562 $whereClause = "WHERE contact_id = %1";
563 $params[1] = array($contactID, 'Integer');
565 $query = "UPDATE civicrm_dashboard_contact SET content = NULL $whereClause";
566 $dao = CRM_Core_DAO
::executeQuery($query, $params);
572 * @param int $dashletID
576 public static function deleteDashlet($dashletID) {
577 $dashlet = new CRM_Core_DAO_Dashboard();
578 $dashlet->id
= $dashletID;