CRM/Core/BAO/Navigation.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  32  */
  33 class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation {
  34
  35   // Number of characters in the menu js cache key
  36   const CACHE_KEY_STRLEN = 8;
  37
  38   /**
  39    * Class constructor.
  40    */
  41   public function __construct() {
  42     parent::__construct();
  43   }
  44
  45   /**
  46    * Update the is_active flag in the db.
  47    *
  48    * @param int $id
  49    *   Id of the database record.
  50    * @param bool $is_active
  51    *   Value we want to set the is_active field.
  52    *
  53    * @return CRM_Core_DAO_Navigation|NULL
  54    *   DAO object on success, NULL otherwise
  55    */
  56   public static function setIsActive($id, $is_active) {
  57     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_Navigation', $id, 'is_active', $is_active);
  58   }
  59
  60   /**
  61    * Add/update navigation record.
  62    *
  63    * @param array $params Submitted values
  64    *
  65    * @return CRM_Core_DAO_Navigation
  66    *   navigation object
  67    */
  68   public static function add(&$params) {
  69     $navigation = new CRM_Core_DAO_Navigation();
  70     if (empty($params['id'])) {
  71       $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
  72       $params['has_separator'] = CRM_Utils_Array::value('has_separator', $params, FALSE);
  73     }
  74
  75     if (!isset($params['id']) ||
  76       (CRM_Utils_Array::value('parent_id', $params) != CRM_Utils_Array::value('current_parent_id', $params))
  77     ) {
  78       /* re/calculate the weight, if the Parent ID changed OR create new menu */
  79
  80       if ($navName = CRM_Utils_Array::value('name', $params)) {
  81         $params['name'] = $navName;
  82       }
  83       elseif ($navLabel = CRM_Utils_Array::value('label', $params)) {
  84         $params['name'] = $navLabel;
  85       }
  86
  87       $params['weight'] = self::calculateWeight(CRM_Utils_Array::value('parent_id', $params));
  88     }
  89
  90     if (array_key_exists('permission', $params) && is_array($params['permission'])) {
  91       $params['permission'] = implode(',', $params['permission']);
  92     }
  93
  94     $navigation->copyValues($params);
  95
  96     $navigation->domain_id = CRM_Core_Config::domainID();
  97
  98     $navigation->save();
  99     return $navigation;
 100   }
 101
 102   /**
 103    * Fetch object based on array of properties.
 104    *
 105    * @param array $params
 106    *   (reference ) an assoc array of name/value pairs.
 107    * @param array $defaults
 108    *   (reference ) an assoc array to hold the flattened values.
 109    *
 110    * @return CRM_Core_BAO_Navigation|null
 111    *   object on success, NULL otherwise
 112    */
 113   public static function retrieve(&$params, &$defaults) {
 114     $navigation = new CRM_Core_DAO_Navigation();
 115     $navigation->copyValues($params);
 116
 117     $navigation->domain_id = CRM_Core_Config::domainID();
 118
 119     if ($navigation->find(TRUE)) {
 120       CRM_Core_DAO::storeValues($navigation, $defaults);
 121       return $navigation;
 122     }
 123     return NULL;
 124   }
 125
 126   /**
 127    * Calculate navigation weight.
 128    *
 129    * @param int $parentID
 130    *   Parent_id of a menu.
 131    * @param int $menuID
 132    *   Menu id.
 133    *
 134    * @return int
 135    *   $weight string
 136    */
 137   public static function calculateWeight($parentID = NULL, $menuID = NULL) {
 138     $domainID = CRM_Core_Config::domainID();
 139
 140     $weight = 1;
 141     // we reset weight for each parent, i.e we start from 1 to n
 142     // calculate max weight for top level menus, if parent id is absent
 143     if (!$parentID) {
 144       $query = "SELECT max(weight) as weight FROM civicrm_navigation WHERE parent_id IS NULL AND domain_id = $domainID";
 145     }
 146     else {
 147       // if parent is passed, we need to get max weight for that particular parent
 148       $query = "SELECT max(weight) as weight FROM civicrm_navigation WHERE parent_id = {$parentID} AND domain_id = $domainID";
 149     }
 150
 151     $dao = CRM_Core_DAO::executeQuery($query);
 152     $dao->fetch();
 153     return $weight = $weight + $dao->weight;
 154   }
 155
 156   /**
 157    * Get formatted menu list.
 158    *
 159    * @return array
 160    *   returns associated array
 161    */
 162   public static function getNavigationList() {
 163     $cacheKeyString = "navigationList";
 164     $whereClause = '';
 165
 166     $config = CRM_Core_Config::singleton();
 167
 168     // check if we can retrieve from database cache
 169     $navigations = CRM_Core_BAO_Cache::getItem('navigation', $cacheKeyString);
 170
 171     if (!$navigations) {
 172       $domainID = CRM_Core_Config::domainID();
 173       $query = "
 174 SELECT id, label, parent_id, weight, is_active, name
 175 FROM civicrm_navigation WHERE domain_id = $domainID {$whereClause} ORDER BY parent_id, weight ASC";
 176       $result = CRM_Core_DAO::executeQuery($query);
 177
 178       $pidGroups = array();
 179       while ($result->fetch()) {
 180         $pidGroups[$result->parent_id][$result->label] = $result->id;
 181       }
 182
 183       foreach ($pidGroups[''] as $label => $val) {
 184         $pidGroups[''][$label] = self::_getNavigationValue($val, $pidGroups);
 185       }
 186
 187       $navigations = array();
 188       self::_getNavigationLabel($pidGroups[''], $navigations);
 189
 190       CRM_Core_BAO_Cache::setItem($navigations, 'navigation', $cacheKeyString);
 191     }
 192     return $navigations;
 193   }
 194
 195   /**
 196    * Helper function for getNavigationList().
 197    *
 198    * @param array $list
 199    *   Menu info.
 200    * @param array $navigations
 201    *   Navigation menus.
 202    * @param string $separator
 203    *   Menu separator.
 204    */
 205   public static function _getNavigationLabel($list, &$navigations, $separator = '') {
 206     $i18n = CRM_Core_I18n::singleton();
 207     foreach ($list as $label => $val) {
 208       if ($label == 'navigation_id') {
 209         continue;
 210       }
 211       $translatedLabel = $i18n->crm_translate($label, array('context' => 'menu'));
 212       $navigations[is_array($val) ? $val['navigation_id'] : $val] = "{$separator}{$translatedLabel}";
 213       if (is_array($val)) {
 214         self::_getNavigationLabel($val, $navigations, $separator . '&nbsp;&nbsp;&nbsp;&nbsp;');
 215       }
 216     }
 217   }
 218
 219   /**
 220    * Helper function for getNavigationList().
 221    *
 222    * @param string $val
 223    *   Menu name.
 224    * @param array $pidGroups
 225    *   Parent menus.
 226    *
 227    * @return array
 228    */
 229   public static function _getNavigationValue($val, &$pidGroups) {
 230     if (array_key_exists($val, $pidGroups)) {
 231       $list = array('navigation_id' => $val);
 232       foreach ($pidGroups[$val] as $label => $id) {
 233         $list[$label] = self::_getNavigationValue($id, $pidGroups);
 234       }
 235       unset($pidGroups[$val]);
 236       return $list;
 237     }
 238     else {
 239       return $val;
 240     }
 241   }
 242
 243   /**
 244    * Build navigation tree.
 245    *
 246    * @return array
 247    *   nested array of menus
 248    */
 249   public static function buildNavigationTree() {
 250     $domainID = CRM_Core_Config::domainID();
 251     $navigationTree = array();
 252
 253     $navigationMenu = new self();
 254     $navigationMenu->domain_id = $domainID;
 255     $navigationMenu->orderBy('parent_id, weight');
 256     $navigationMenu->find();
 257
 258     while ($navigationMenu->fetch()) {
 259       $navigationTree[$navigationMenu->id] = array(
 260         'attributes' => array(
 261           'label' => $navigationMenu->label,
 262           'name' => $navigationMenu->name,
 263           'url' => $navigationMenu->url,
 264           'icon' => $navigationMenu->icon,
 265           'permission' => $navigationMenu->permission,
 266           'operator' => $navigationMenu->permission_operator,
 267           'separator' => $navigationMenu->has_separator,
 268           'parentID' => $navigationMenu->parent_id,
 269           'navID' => $navigationMenu->id,
 270           'active' => $navigationMenu->is_active,
 271         ),
 272       );
 273     }
 274
 275     return self::buildTree($navigationTree);
 276   }
 277
 278   /**
 279    * Convert flat array to nested.
 280    *
 281    * @param array $elements
 282    * @param int|null $parentId
 283    *
 284    * @return array
 285    */
 286   private static function buildTree($elements, $parentId = NULL) {
 287     $branch = array();
 288
 289     foreach ($elements as $id => $element) {
 290       if ($element['attributes']['parentID'] == $parentId) {
 291         $children = self::buildTree($elements, $id);
 292         if ($children) {
 293           $element['child'] = $children;
 294         }
 295         $branch[$id] = $element;
 296       }
 297     }
 298
 299     return $branch;
 300   }
 301
 302   /**
 303    * Build menu.
 304    *
 305    * @return string
 306    */
 307   public static function buildNavigation() {
 308     $navigations = self::buildNavigationTree();
 309     $navigationString = '';
 310
 311     // run the Navigation  through a hook so users can modify it
 312     CRM_Utils_Hook::navigationMenu($navigations);
 313     self::fixNavigationMenu($navigations);
 314
 315     //skip children menu item if user don't have access to parent menu item
 316     $skipMenuItems = array();
 317     foreach ($navigations as $key => $value) {
 318       // Home is a special case
 319       if ($value['attributes']['name'] != 'Home') {
 320         $name = self::getMenuName($value, $skipMenuItems);
 321         if ($name) {
 322           //separator before
 323           if (isset($value['attributes']['separator']) && $value['attributes']['separator'] == 2) {
 324             $navigationString .= '<li class="menu-separator"></li>';
 325           }
 326           $removeCharacters = array('/', '!', '&', '*', ' ', '(', ')', '.');
 327           $navigationString .= '<li class="menumain crm-' . str_replace($removeCharacters, '_', $value['attributes']['label']) . '">' . $name;
 328         }
 329       }
 330       self::recurseNavigation($value, $navigationString, $skipMenuItems);
 331     }
 332
 333     // clean up - Need to remove empty <ul>'s, this happens when user don't have
 334     // permission to access parent
 335     $navigationString = str_replace('<ul></ul></li>', '', $navigationString);
 336
 337     return $navigationString;
 338   }
 339
 340   /**
 341    * Recursively check child menus.
 342    *
 343    * @param array $value
 344    * @param string $navigationString
 345    * @param array $skipMenuItems
 346    *
 347    * @return string
 348    */
 349   public static function recurseNavigation(&$value, &$navigationString, $skipMenuItems) {
 350     if (!empty($value['child'])) {
 351       $navigationString .= '<ul>';
 352     }
 353     else {
 354       $navigationString .= '</li>';
 355       //locate separator after
 356       if (isset($value['attributes']['separator']) && $value['attributes']['separator'] == 1) {
 357         $navigationString .= '<li class="menu-separator"></li>';
 358       }
 359     }
 360
 361     if (!empty($value['child'])) {
 362       foreach ($value['child'] as $val) {
 363         $name = self::getMenuName($val, $skipMenuItems);
 364         if ($name) {
 365           //locate separator before
 366           if (isset($val['attributes']['separator']) && $val['attributes']['separator'] == 2) {
 367             $navigationString .= '<li class="menu-separator"></li>';
 368           }
 369           $removeCharacters = array('/', '!', '&', '*', ' ', '(', ')', '.');
 370           $navigationString .= '<li class="crm-' . str_replace($removeCharacters, '_', $val['attributes']['label']) . '">' . $name;
 371           self::recurseNavigation($val, $navigationString, $skipMenuItems);
 372         }
 373       }
 374     }
 375     if (!empty($value['child'])) {
 376       $navigationString .= '</ul></li>';
 377       if (isset($value['attributes']['separator']) && $value['attributes']['separator'] == 1) {
 378         $navigationString .= '<li class="menu-separator"></li>';
 379       }
 380     }
 381     return $navigationString;
 382   }
 383
 384   /**
 385    * Given a navigation menu, generate navIDs for any items which are
 386    * missing them.
 387    *
 388    * @param array $nodes
 389    *   Each key is a numeral; each value is a node in
 390    *   the menu tree (with keys "child" and "attributes").
 391    */
 392   public static function fixNavigationMenu(&$nodes) {
 393     $maxNavID = 1;
 394     array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
 395       if ($key === 'navID') {
 396         $maxNavID = max($maxNavID, $item);
 397       }
 398     });
 399     self::_fixNavigationMenu($nodes, $maxNavID, NULL);
 400   }
 401
 402   /**
 403    * @param array $nodes
 404    *   Each key is a numeral; each value is a node in
 405    *   the menu tree (with keys "child" and "attributes").
 406    * @param int $maxNavID
 407    * @param int $parentID
 408    */
 409   private static function _fixNavigationMenu(&$nodes, &$maxNavID, $parentID) {
 410     $origKeys = array_keys($nodes);
 411     foreach ($origKeys as $origKey) {
 412       if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) {
 413         $nodes[$origKey]['attributes']['parentID'] = $parentID;
 414       }
 415       // If no navID, then assign navID and fix key.
 416       if (!isset($nodes[$origKey]['attributes']['navID'])) {
 417         $newKey = ++$maxNavID;
 418         $nodes[$origKey]['attributes']['navID'] = $newKey;
 419         if ($origKey != $newKey) {
 420           // If the keys are different, reset the array index to match.
 421           $nodes[$newKey] = $nodes[$origKey];
 422           unset($nodes[$origKey]);
 423           $origKey = $newKey;
 424         }
 425       }
 426       if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) {
 427         self::_fixNavigationMenu($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
 428       }
 429     }
 430   }
 431
 432   /**
 433    * Get Menu name.
 434    *
 435    * @param $value
 436    * @param array $skipMenuItems
 437    *
 438    * @return bool|string
 439    */
 440   public static function getMenuName(&$value, &$skipMenuItems) {
 441     // we need to localise the menu labels (CRM-5456) and don’t
 442     // want to use ts() as it would throw the ts-extractor off
 443     $i18n = CRM_Core_I18n::singleton();
 444
 445     $name = $i18n->crm_translate($value['attributes']['label'], array('context' => 'menu'));
 446     $url = CRM_Utils_Array::value('url', $value['attributes']);
 447     $permission = CRM_Utils_Array::value('permission', $value['attributes']);
 448     $operator = CRM_Utils_Array::value('operator', $value['attributes']);
 449     $parentID = CRM_Utils_Array::value('parentID', $value['attributes']);
 450     $navID = CRM_Utils_Array::value('navID', $value['attributes']);
 451     $active = CRM_Utils_Array::value('active', $value['attributes']);
 452     $menuName = CRM_Utils_Array::value('name', $value['attributes']);
 453     $target = CRM_Utils_Array::value('target', $value['attributes']);
 454
 455     if (in_array($parentID, $skipMenuItems) || !$active) {
 456       $skipMenuItems[] = $navID;
 457       return FALSE;
 458     }
 459
 460     $config = CRM_Core_Config::singleton();
 461
 462     $makeLink = FALSE;
 463     if (isset($url) && $url) {
 464       if (substr($url, 0, 4) !== 'http') {
 465         //CRM-7656 --make sure to separate out url path from url params,
 466         //as we'r going to validate url path across cross-site scripting.
 467         $parsedUrl = parse_url($url);
 468         if (empty($parsedUrl['query'])) {
 469           $parsedUrl['query'] = NULL;
 470         }
 471         if (empty($parsedUrl['fragment'])) {
 472           $parsedUrl['fragment'] = NULL;
 473         }
 474         $url = CRM_Utils_System::url($parsedUrl['path'], $parsedUrl['query'], FALSE, $parsedUrl['fragment'], TRUE);
 475       }
 476       elseif (strpos($url, '&amp;') === FALSE) {
 477         $url = htmlspecialchars($url);
 478       }
 479       $makeLink = TRUE;
 480     }
 481
 482     static $allComponents;
 483     if (!$allComponents) {
 484       $allComponents = CRM_Core_Component::getNames();
 485     }
 486
 487     if (isset($permission) && $permission) {
 488       $permissions = explode(',', $permission);
 489
 490       $hasPermission = FALSE;
 491       foreach ($permissions as $key) {
 492         $key = trim($key);
 493         $showItem = TRUE;
 494
 495         //get the component name from permission.
 496         $componentName = CRM_Core_Permission::getComponentName($key);
 497
 498         if ($componentName) {
 499           if (!in_array($componentName, $config->enableComponents) ||
 500             !CRM_Core_Permission::check($key)
 501           ) {
 502             $showItem = FALSE;
 503             if ($operator == 'AND') {
 504               $skipMenuItems[] = $navID;
 505               return $showItem;
 506             }
 507           }
 508           else {
 509             $hasPermission = TRUE;
 510           }
 511         }
 512         elseif (!CRM_Core_Permission::check($key)) {
 513           $showItem = FALSE;
 514           if ($operator == 'AND') {
 515             $skipMenuItems[] = $navID;
 516             return $showItem;
 517           }
 518         }
 519         else {
 520           $hasPermission = TRUE;
 521         }
 522       }
 523
 524       if (!$showItem && !$hasPermission) {
 525         $skipMenuItems[] = $navID;
 526         return FALSE;
 527       }
 528     }
 529
 530     if (!empty($value['attributes']['icon'])) {
 531       $menuIcon = sprintf('<span class="%s"></span>&nbsp;', $value['attributes']['icon']);
 532       $name = $menuIcon . $name;
 533     }
 534
 535     if ($makeLink) {
 536       $url = CRM_Utils_System::evalUrl($url);
 537       if ($target) {
 538         $name = "<a href=\"{$url}\" target=\"{$target}\">{$name}</a>";
 539       }
 540       else {
 541         $name = "<a href=\"{$url}\">{$name}</a>";
 542       }
 543     }
 544
 545     return $name;
 546   }
 547
 548   /**
 549    * Create navigation for CiviCRM Admin Menu.
 550    *
 551    * @param int $contactID
 552    *   Contact id.
 553    *
 554    * @return string
 555    *   returns navigation html
 556    */
 557   public static function createNavigation($contactID) {
 558     $config = CRM_Core_Config::singleton();
 559
 560     $navigation = self::buildNavigation();
 561
 562     if ($navigation) {
 563
 564       //add additional navigation items
 565       $logoutURL = CRM_Utils_System::url('civicrm/logout', 'reset=1');
 566
 567       // get home menu from db
 568       $homeParams = array('name' => 'Home');
 569       $homeNav = array();
 570       $homeIcon = '<span class="crm-logo-sm" ></span>';
 571       self::retrieve($homeParams, $homeNav);
 572       if ($homeNav) {
 573         list($path, $q) = explode('?', $homeNav['url']);
 574         $homeURL = CRM_Utils_System::url($path, $q);
 575         $homeLabel = $homeNav['label'];
 576         // CRM-6804 (we need to special-case this as we don’t ts()-tag variables)
 577         if ($homeLabel == 'Home') {
 578           $homeLabel = ts('CiviCRM Home');
 579         }
 580       }
 581       else {
 582         $homeURL = CRM_Utils_System::url('civicrm/dashboard', 'reset=1');
 583         $homeLabel = ts('CiviCRM Home');
 584       }
 585       // Link to hide the menubar
 586       $hideLabel = ts('Hide Menu');
 587
 588       $prepandString = "
 589         <li class='menumain crm-link-home'>$homeIcon
 590           <ul id='civicrm-home'>
 591             <li><a href='$homeURL'>$homeLabel</a></li>
 592             <li><a href='#' class='crm-hidemenu'>$hideLabel</a></li>
 593             <li><a href='$logoutURL' class='crm-logout-link'>" . ts('Log out') . "</a></li>
 594           </ul>";
 595       // <li> tag doesn't need to be closed
 596     }
 597     return $prepandString . $navigation;
 598   }
 599
 600   /**
 601    * Reset navigation for all contacts or a specified contact.
 602    *
 603    * @param int $contactID
 604    *   Reset only entries belonging to that contact ID.
 605    *
 606    * @return string
 607    */
 608   public static function resetNavigation($contactID = NULL) {
 609     $newKey = CRM_Utils_String::createRandom(self::CACHE_KEY_STRLEN, CRM_Utils_String::ALPHANUMERIC);
 610     if (!$contactID) {
 611       $query = "UPDATE civicrm_setting SET value = '$newKey' WHERE name='navigation' AND contact_id IS NOT NULL";
 612       CRM_Core_DAO::executeQuery($query);
 613       CRM_Core_BAO_Cache::deleteGroup('navigation');
 614     }
 615     else {
 616       // before inserting check if contact id exists in db
 617       // this is to handle weird case when contact id is in session but not in db
 618       $contact = new CRM_Contact_DAO_Contact();
 619       $contact->id = $contactID;
 620       if ($contact->find(TRUE)) {
 621         CRM_Core_BAO_Setting::setItem(
 622           $newKey,
 623           CRM_Core_BAO_Setting::PERSONAL_PREFERENCES_NAME,
 624           'navigation',
 625           NULL,
 626           $contactID,
 627           $contactID
 628         );
 629       }
 630     }
 631
 632     return $newKey;
 633   }
 634
 635   /**
 636    * Process navigation.
 637    *
 638    * @param array $params
 639    *   Associated array, $_GET.
 640    */
 641   public static function processNavigation(&$params) {
 642     $nodeID = (int) str_replace("node_", "", $params['id']);
 643     $referenceID = (int) str_replace("node_", "", $params['ref_id']);
 644     $position = $params['ps'];
 645     $type = $params['type'];
 646     $label = CRM_Utils_Array::value('data', $params);
 647
 648     switch ($type) {
 649       case "move":
 650         self::processMove($nodeID, $referenceID, $position);
 651         break;
 652
 653       case "rename":
 654         self::processRename($nodeID, $label);
 655         break;
 656
 657       case "delete":
 658         self::processDelete($nodeID);
 659         break;
 660     }
 661
 662     //reset navigation menus
 663     self::resetNavigation();
 664     CRM_Utils_System::civiExit();
 665   }
 666
 667   /**
 668    * Process move action.
 669    *
 670    * @param $nodeID
 671    *   Node that is being moved.
 672    * @param $referenceID
 673    *   Parent id where node is moved. 0 mean no parent.
 674    * @param $position
 675    *   New position of the nod, it starts with 0 - n.
 676    */
 677   public static function processMove($nodeID, $referenceID, $position) {
 678     // based on the new position we need to get the weight of the node after moved node
 679     // 1. update the weight of $position + 1 nodes to weight + 1
 680     // 2. weight of the ( $position -1 ) node - 1 is the new weight of the node being moved
 681
 682     // check if there is parent id, which means node is moved inside existing parent container, so use parent id
 683     // to find the correct position else use NULL to get the weights of parent ( $position - 1 )
 684     // accordingly set the new parent_id
 685     if ($referenceID) {
 686       $newParentID = $referenceID;
 687       $parentClause = "parent_id = {$referenceID} ";
 688     }
 689     else {
 690       $newParentID = 'NULL';
 691       $parentClause = 'parent_id IS NULL';
 692     }
 693
 694     $incrementOtherNodes = TRUE;
 695     $sql = "SELECT weight from civicrm_navigation WHERE {$parentClause} ORDER BY weight LIMIT %1, 1";
 696     $params = array(1 => array($position, 'Positive'));
 697     $newWeight = CRM_Core_DAO::singleValueQuery($sql, $params);
 698
 699     // this means node is moved to last position, so you need to get the weight of last element + 1
 700     if (!$newWeight) {
 701       // If this is not the first item being added to a parent
 702       if ($position) {
 703         $lastPosition = $position - 1;
 704         $sql = "SELECT weight from civicrm_navigation WHERE {$parentClause} ORDER BY weight LIMIT %1, 1";
 705         $params = array(1 => array($lastPosition, 'Positive'));
 706         $newWeight = CRM_Core_DAO::singleValueQuery($sql, $params);
 707
 708         // since last node increment + 1
 709         $newWeight = $newWeight + 1;
 710       }
 711       else {
 712         $newWeight = '0';
 713       }
 714
 715       // since this is a last node we don't need to increment other nodes
 716       $incrementOtherNodes = FALSE;
 717     }
 718
 719     $transaction = new CRM_Core_Transaction();
 720
 721     // now update the existing nodes to weight + 1, if required.
 722     if ($incrementOtherNodes) {
 723       $query = "UPDATE civicrm_navigation SET weight = weight + 1
 724                   WHERE {$parentClause} AND weight >= {$newWeight}";
 725
 726       CRM_Core_DAO::executeQuery($query);
 727     }
 728
 729     // finally set the weight of current node
 730     $query = "UPDATE civicrm_navigation SET weight = {$newWeight}, parent_id = {$newParentID} WHERE id = {$nodeID}";
 731     CRM_Core_DAO::executeQuery($query);
 732
 733     $transaction->commit();
 734   }
 735
 736   /**
 737    * Function to process rename action for tree.
 738    *
 739    * @param int $nodeID
 740    * @param $label
 741    */
 742   public static function processRename($nodeID, $label) {
 743     CRM_Core_DAO::setFieldValue('CRM_Core_DAO_Navigation', $nodeID, 'label', $label);
 744   }
 745
 746   /**
 747    * Process delete action for tree.
 748    *
 749    * @param int $nodeID
 750    */
 751   public static function processDelete($nodeID) {
 752     $query = "DELETE FROM civicrm_navigation WHERE id = {$nodeID}";
 753     CRM_Core_DAO::executeQuery($query);
 754   }
 755
 756   /**
 757    * Update menu.
 758    *
 759    * @param array $params
 760    * @param array $newParams
 761    *   New value of params.
 762    */
 763   public static function processUpdate($params, $newParams) {
 764     $dao = new CRM_Core_DAO_Navigation();
 765     $dao->copyValues($params);
 766     if ($dao->find(TRUE)) {
 767       $dao->copyValues($newParams);
 768       $dao->save();
 769     }
 770   }
 771
 772   /**
 773    * Rebuild reports menu.
 774    *
 775    * All Contact reports will become sub-items of 'Contact Reports' and so on.
 776    *
 777    * @param int $domain_id
 778    */
 779   public static function rebuildReportsNavigation($domain_id) {
 780     $component_to_nav_name = array(
 781       'CiviContact' => 'Contact Reports',
 782       'CiviContribute' => 'Contribution Reports',
 783       'CiviMember' => 'Membership Reports',
 784       'CiviEvent' => 'Event Reports',
 785       'CiviPledge' => 'Pledge Reports',
 786       'CiviGrant' => 'Grant Reports',
 787       'CiviMail' => 'Mailing Reports',
 788       'CiviCampaign' => 'Campaign Reports',
 789     );
 790
 791     // Create or update the top level Reports link.
 792     $reports_nav = self::createOrUpdateTopLevelReportsNavItem($domain_id);
 793
 794     // Get all active report instances grouped by component.
 795     $components = self::getAllActiveReportsByComponent($domain_id);
 796     foreach ($components as $component_id => $component) {
 797       // Create or update the per component reports links.
 798       $component_nav_name = $component['name'];
 799       if (isset($component_to_nav_name[$component_nav_name])) {
 800         $component_nav_name = $component_to_nav_name[$component_nav_name];
 801       }
 802       $permission = "access {$component['name']}";
 803       if ($component['name'] === 'CiviContact') {
 804         $permission = "administer CiviCRM";
 805       }
 806       elseif ($component['name'] === 'CiviCampaign') {
 807         $permission = "access CiviReport";
 808       }
 809       $component_nav = self::createOrUpdateReportNavItem($component_nav_name, 'civicrm/report/list',
 810         "compid={$component_id}&reset=1", $reports_nav->id, $permission, $domain_id, TRUE);
 811       foreach ($component['reports'] as $report_id => $report) {
 812         // Create or update the report instance links.
 813         $report_nav = self::createOrUpdateReportNavItem($report['title'], $report['url'], 'reset=1', $component_nav->id, $report['permission'], $domain_id, FALSE, TRUE);
 814         // Update the report instance to include the navigation id.
 815         $query = "UPDATE civicrm_report_instance SET navigation_id = %1 WHERE id = %2";
 816         $params = array(
 817           1 => array($report_nav->id, 'Integer'),
 818           2 => array($report_id, 'Integer'),
 819         );
 820         CRM_Core_DAO::executeQuery($query, $params);
 821       }
 822     }
 823
 824     // Create or update the All Reports link.
 825     self::createOrUpdateReportNavItem('All Reports', 'civicrm/report/list', 'reset=1', $reports_nav->id, 'access CiviReport', $domain_id, TRUE);
 826     // Create or update the My Reports link.
 827     self::createOrUpdateReportNavItem('My Reports', 'civicrm/report/list', 'myreports=1&reset=1', $reports_nav->id, 'access CiviReport', $domain_id, TRUE);
 828
 829   }
 830
 831   /**
 832    * Create the top level 'Reports' item in the navigation tree.
 833    *
 834    * @param int $domain_id
 835    *
 836    * @return bool|\CRM_Core_DAO
 837    */
 838   static public function createOrUpdateTopLevelReportsNavItem($domain_id) {
 839     $id = NULL;
 840
 841     $dao = new CRM_Core_BAO_Navigation();
 842     $dao->name = 'Reports';
 843     $dao->domain_id = $domain_id;
 844     // The first selectAdd clears it - so that we only retrieve the one field.
 845     $dao->selectAdd();
 846     $dao->selectAdd('id');
 847     if ($dao->find(TRUE)) {
 848       $id = $dao->id;
 849     }
 850
 851     $nav = self::createReportNavItem('Reports', NULL, NULL, NULL, 'access CiviReport', $id, $domain_id);
 852     return $nav;
 853   }
 854
 855   /**
 856    * Retrieve a navigation item using it's url.
 857    *
 858    * Note that we use LIKE to permit a wildcard as the calling code likely doesn't
 859    * care about output params appended.
 860    *
 861    * @param string $url
 862    * @param array $url_params
 863    *
 864    * @param int|null $parent_id
 865    *   Optionally restrict to one parent.
 866    *
 867    * @return bool|\CRM_Core_BAO_Navigation
 868    */
 869   public static function getNavItemByUrl($url, $url_params, $parent_id = NULL) {
 870     $nav = new CRM_Core_BAO_Navigation();
 871     $nav->parent_id = $parent_id;
 872     $nav->whereAdd("url LIKE '{$url}?{$url_params}'");
 873
 874     if ($nav->find(TRUE)) {
 875       return $nav;
 876     }
 877     return FALSE;
 878   }
 879
 880   /**
 881    * Get all active reports, organised by component.
 882    *
 883    * @param int $domain_id
 884    *
 885    * @return array
 886    */
 887   public static function getAllActiveReportsByComponent($domain_id) {
 888     $sql = "
 889       SELECT
 890         civicrm_report_instance.id, civicrm_report_instance.title, civicrm_report_instance.permission, civicrm_component.name, civicrm_component.id AS component_id
 891       FROM
 892         civicrm_option_group
 893       LEFT JOIN
 894         civicrm_option_value ON civicrm_option_value.option_group_id = civicrm_option_group.id AND civicrm_option_group.name = 'report_template'
 895       LEFT JOIN
 896         civicrm_report_instance ON civicrm_option_value.value = civicrm_report_instance.report_id
 897       LEFT JOIN
 898         civicrm_component ON civicrm_option_value.component_id = civicrm_component.id
 899       WHERE
 900         civicrm_option_value.is_active = 1
 901       AND
 902         civicrm_report_instance.domain_id = %1
 903       ORDER BY civicrm_option_value.weight";
 904
 905     $dao = CRM_Core_DAO::executeQuery($sql, array(
 906       1 => array($domain_id, 'Integer'),
 907     ));
 908     $rows = array();
 909     while ($dao->fetch()) {
 910       $component_name = is_null($dao->name) ? 'CiviContact' : $dao->name;
 911       $component_id = is_null($dao->component_id) ? 99 : $dao->component_id;
 912       $rows[$component_id]['name'] = $component_name;
 913       $rows[$component_id]['reports'][$dao->id] = array(
 914         'title' => $dao->title,
 915         'url' => "civicrm/report/instance/{$dao->id}",
 916         'permission' => $dao->permission,
 917       );
 918     }
 919     return $rows;
 920   }
 921
 922   /**
 923    * Create or update a navigation item for a report instance.
 924    *
 925    * The function will check whether create or update is required.
 926    *
 927    * @param string $name
 928    * @param string $url
 929    * @param string $url_params
 930    * @param int $parent_id
 931    * @param string $permission
 932    * @param int $domain_id
 933    *
 934    * @param bool $onlyMatchParentID
 935    *   If True then do not match with a url that has a different parent
 936    *   (This is because for top level items there is a risk of 'stealing' rows that normally
 937    *   live under 'Contact' and intentionally duplicate the report examples.)
 938    *
 939    * @return \CRM_Core_DAO_Navigation
 940    */
 941   protected static function createOrUpdateReportNavItem($name, $url, $url_params, $parent_id, $permission,
 942                                                         $domain_id, $onlyMatchParentID = FALSE, $useWildcard = TRUE) {
 943     $id = NULL;
 944     $existing_url_params = $useWildcard ? $url_params . '%' : $url_params;
 945     $existing_nav = CRM_Core_BAO_Navigation::getNavItemByUrl($url, $existing_url_params, ($onlyMatchParentID ? $parent_id : NULL));
 946     if ($existing_nav) {
 947       $id = $existing_nav->id;
 948     }
 949
 950     $nav = self::createReportNavItem($name, $url, $url_params, $parent_id, $permission, $id, $domain_id);
 951     return $nav;
 952   }
 953
 954   /**
 955    * Create a navigation item for a report instance.
 956    *
 957    * @param string $name
 958    * @param string $url
 959    * @param string $url_params
 960    * @param int $parent_id
 961    * @param string $permission
 962    * @param int $id
 963    * @param int $domain_id
 964    *   ID of domain to create item in.
 965    *
 966    * @return \CRM_Core_DAO_Navigation
 967    */
 968   public static function createReportNavItem($name, $url, $url_params, $parent_id, $permission, $id, $domain_id) {
 969     if ($url !== NULL) {
 970       $url = "{$url}?{$url_params}";
 971     }
 972     $params = array(
 973       'name' => $name,
 974       'label' => ts($name),
 975       'url' => $url,
 976       'parent_id' => $parent_id,
 977       'is_active' => TRUE,
 978       'permission' => array(
 979         $permission,
 980       ),
 981       'domain_id' => $domain_id,
 982     );
 983     if ($id) {
 984       $params['id'] = $id;
 985     }
 986     return CRM_Core_BAO_Navigation::add($params);
 987   }
 988
 989   /**
 990    * Get cache key.
 991    *
 992    * @param int $cid
 993    *
 994    * @return object|string
 995    */
 996   public static function getCacheKey($cid) {
 997     $key = Civi::service('settings_manager')
 998       ->getBagByContact(NULL, $cid)
 999       ->get('navigation');
1000     if (strlen($key) !== self::CACHE_KEY_STRLEN) {
1001       $key = self::resetNavigation($cid);
1002     }
1003     return $key;
1004   }
1005
1006 }