gacl/gacl.class.php

   1 <?php
   2 // $Id$
   3
   4 /**
   5  * phpGACL - Generic Access Control List
   6  * Copyright (C) 2002,2003 Mike Benoit
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  * For questions, help, comments, discussion, etc., please join the
  23  * phpGACL mailing list. http://sourceforge.net/mail/?group_id=57103
  24  *
  25  * You may contact the author of phpGACL by e-mail at:
  26  * ipso@snappymail.ca
  27  *
  28  * The latest version of phpGACL can be obtained from:
  29  * http://phpgacl.sourceforge.net/
  30  *
  31  * @package phpGACL
  32  */
  33
  34 /*
  35  * Path to ADODB.
  36  */
  37
  38 if ( !defined('ADODB_DIR') ) {
  39         define('ADODB_DIR', dirname(__FILE__).'/adodb');
  40 }
  41
  42 //openemr configuration file - bm - 05-2009
  43 // to collect sql database login info and the utf8 flag
  44 include_once(dirname(__FILE__).'/../library/sqlconf.php');
  45
  46 /**
  47 * phpGACL main class
  48 *
  49 * Class gacl should be used in applications where only querying the phpGACL
  50 * database is required.
  51 *
  52 * @package phpGACL
  53 * @author Mike Benoit <ipso@snappymail.ca>
  54 */
  55 class gacl {
  56         /*
  57         --- phpGACL Configuration path/file ---
  58         */
  59         var $config_file = '';
  60
  61         /*
  62         --- Private properties ---
  63         */
  64         /** @var boolean Enables Debug output if true */
  65         var $_debug = FALSE;
  66
  67         /*
  68         --- Database configuration. ---
  69         */
  70         /** @var string Prefix for all the phpgacl tables in the database */
  71         var $_db_table_prefix = 'gacl_';
  72
  73         /** @var string The database type, based on available ADODB connectors - mysql, postgres7, sybase, oci8po See here for more: http://php.weblogs.com/adodb_manual#driverguide */
  74         var $_db_type = 'mysql';
  75
  76         /** @var string The database server */
  77         var $_db_host = '';
  78
  79         /** @var string The database user name */
  80         var $_db_user = '';
  81
  82         /** @var string The database user password */
  83         var $_db_password = '';
  84
  85         /** @var string The database name */
  86         var $_db_name = '';
  87
  88         /** @var object An ADODB database connector object */
  89         var $_db = '';
  90
  91         /** @var boolean The utf8 encoding flag - bm 05-2009 */
  92         var $_db_utf8_flag = '';
  93
  94         /*
  95          * NOTE:        This cache must be manually cleaned each time ACL's are modified.
  96          *              Alternatively you could wait for the cache to expire.
  97          */
  98
  99         /** @var boolean Caches queries if true */
 100         var $_caching = FALSE;
 101
 102         /** @var boolean Force cache to expire */
 103         var $_force_cache_expire = TRUE;
 104
 105         /** @var string The directory for cache file to eb written (ensure write permission are set) */
 106         var $_cache_dir = '/tmp/phpgacl_cache'; // NO trailing slash
 107
 108         /** @var int The time for the cache to expire in seconds - 600 == Ten Minutes */
 109         var $_cache_expire_time=600;
 110
 111         /** @var string A switch to put acl_check into '_group_' mode */
 112         var $_group_switch = '_group_';
 113
 114         /**
 115          * Constructor
 116          * @param array An arry of options to oeverride the class defaults
 117          */
 118         function gacl($options = NULL) {
 119
 120                 $available_options = array('db','debug','items_per_page','max_select_box_items','max_search_return_items','db_table_prefix','db_type','db_host','db_user','db_password','db_name','caching','force_cache_expire','cache_dir','cache_expire_time');
 121
 122                 //Values supplied in $options array overwrite those in the config file.
 123                 if ( file_exists($this->config_file) ) {
 124                         $config = parse_ini_file($this->config_file);
 125
 126                         if ( is_array($config) ) {
 127                                 $gacl_options = array_merge($config, $options);
 128                         }
 129
 130                         unset($config);
 131                 }
 132
 133                 if (is_array($options)) {
 134                         foreach ($options as $key => $value) {
 135                                 $this->debug_text("Option: $key");
 136
 137                                 if (in_array($key, $available_options) ) {
 138                                         $this->debug_text("Valid Config options: $key");
 139                                         $property = '_'.$key;
 140                                         $this->$property = $value;
 141                                 } else {
 142                                         $this->debug_text("ERROR: Config option: $key is not a valid option");
 143                                 }
 144                         }
 145                 }
 146
 147                 //collect openemr sql info from include at top of script - bm 05-2009
 148                 global $sqlconf, $disable_utf8_flag;
 149                 $this->_db_host = $sqlconf["host"].":".$sqlconf["port"];
 150                 $this->_db_user = $sqlconf["login"];
 151                 $this->_db_password = $sqlconf["pass"];
 152                 $this->_db_name = $sqlconf["dbase"];
 153                 if (!$disable_utf8_flag) {
 154                 $utf8_flag = true;
 155                 }
 156                 else {
 157                 $utf8_flag = false;
 158                 }
 159                 $this->_db_utf8_flag = $utf8_flag;
 160
 161                 require_once( ADODB_DIR .'/adodb.inc.php');
 162                 require_once( ADODB_DIR .'/adodb-pager.inc.php');
 163
 164                 if (is_object($this->_db)) {
 165                         $this->db = &$this->_db;
 166                 } else {
 167                         $this->db = ADONewConnection($this->_db_type);
 168                         //Use NUM for slight performance/memory reasons.
 169                         $this->db->SetFetchMode(ADODB_FETCH_NUM);
 170                         $this->db->PConnect($this->_db_host, $this->_db_user, $this->_db_password, $this->_db_name);
 171
 172                         // Modified 5/2009 by BM for UTF-8 project
 173                         if ($this->_db_utf8_flag) {
 174                                 $success_flag = $this->db->Execute("SET NAMES 'utf8'");
 175                                 if (!$success_flag) {
 176                                         error_log("PHP custom error: from gacl gacl/gacl.class.php  - Unable to set up UTF8 encoding with mysql database".$this->db->ErrorMsg(), 0);
 177                                 }
 178                         }
 179                         // ---------------------------------------
 180
 181                 }
 182                 $this->db->debug = $this->_debug;
 183
 184                 if ( $this->_caching == TRUE ) {
 185                         if (!class_exists('Hashed_Cache_Lite')) {
 186                                 require_once(dirname(__FILE__) .'/Cache_Lite/Hashed_Cache_Lite.php');
 187                         }
 188
 189                         /*
 190                          * Cache options. We default to the highest performance. If you run in to cache corruption problems,
 191                          * Change all the 'false' to 'true', this will slow things down slightly however.
 192                          */
 193
 194                         $cache_options = array(
 195                                 'caching' => $this->_caching,
 196                                 'cacheDir' => $this->_cache_dir.'/',
 197                                 'lifeTime' => $this->_cache_expire_time,
 198                                 'fileLocking' => TRUE,
 199                                 'writeControl' => FALSE,
 200                                 'readControl' => FALSE,
 201                                 'memoryCaching' => TRUE,
 202                                 'automaticSerialization' => FALSE
 203                         );
 204                         $this->Cache_Lite = new Hashed_Cache_Lite($cache_options);
 205                 }
 206
 207                 return true;
 208         }
 209
 210         /**
 211         * Prints debug text if debug is enabled.
 212         * @param string THe text to output
 213         * @return boolean Always returns true
 214         */
 215         function debug_text($text) {
 216
 217                 if ($this->_debug) {
 218                         echo "$text<br>\n";
 219                 }
 220
 221                 return true;
 222         }
 223
 224         /**
 225         * Prints database debug text if debug is enabled.
 226         * @param string The name of the function calling this method
 227         * @return string Returns an error message
 228         */
 229         function debug_db($function_name = '') {
 230                 if ($function_name != '') {
 231                         $function_name .= ' (): ';
 232                 }
 233
 234                 return $this->debug_text ($function_name .'database error: '. $this->db->ErrorMsg() .' ('. $this->db->ErrorNo() .')');
 235         }
 236
 237         /**
 238         *
 239         * Check if the current user has a given type or types of access to an access control object.
 240         *
 241         * Implemented as a wrapper of acl_query().
 242         * This function exists simply to return TRUE/FALSE accordingly.
 243         *
 244         * @param string $aco_section_value The ACO section value
 245         * @param string $aco_value The ACO value
 246         * @param string $aro_section_value The ARO section value
 247         * @param string $aro_value The ARO value
 248         * @param string $axo_section_value The AXO section value (optional)
 249         * @param string $axo_value The AXO section value (optional)
 250         * @param integer $root_aro_group The group id of the ARO (optional)
 251         * @param integer $root_axo_group The group id of the AXO (optional)
 252         * @return boolean true if the check succeeds, false if not.
 253         */
 254         function acl_check($aco_section_value, $aco_value, $aro_section_value, $aro_value, $axo_section_value=NULL, $axo_value=NULL, $root_aro_group=NULL, $root_axo_group=NULL) {
 255                 $acl_result = $this->acl_query($aco_section_value, $aco_value, $aro_section_value, $aro_value, $axo_section_value, $axo_value, $root_aro_group, $root_axo_group);
 256
 257                 return $acl_result['allow'];
 258         }
 259
 260         /**
 261         * Wraps the actual acl_query() function.
 262         *
 263         * Quick access to the return value of an ACL.
 264         * @param string The ACO section value
 265         * @param string The ACO value
 266         * @param string The ARO section value
 267         * @param string The ARO section
 268         * @param string The AXO section value (optional)
 269         * @param string The AXO section value (optional)
 270         * @param integer The group id of the ARO (optional)
 271         * @param integer The group id of the AXO (optional)
 272         * @return string The return value of the ACL
 273         */
 274         function acl_return_value($aco_section_value, $aco_value, $aro_section_value, $aro_value, $axo_section_value=NULL, $axo_value=NULL, $root_aro_group=NULL, $root_axo_group=NULL) {
 275                 $acl_result = $this->acl_query($aco_section_value, $aco_value, $aro_section_value, $aro_value, $axo_section_value, $axo_value, $root_aro_group, $root_axo_group);
 276
 277                 return $acl_result['return_value'];
 278         }
 279
 280         /**
 281         * Handles ACL lookups over arrays of AROs
 282         * @param string The ACO section value
 283         * @param string The ACO value
 284         * @param array An named array of arrays, each element in the format aro_section_value=>array(aro_value1,aro_value1,...)
 285         * @return mixed The same data format as inputted.
 286         \*======================================================================*/
 287         function acl_check_array($aco_section_value, $aco_value, $aro_array) {
 288                 /*
 289                         Input Array:
 290                                 Section => array(Value, Value, Value),
 291                                 Section => array(Value, Value, Value)
 292
 293                  */
 294
 295                 if (!is_array($aro_array)) {
 296                         $this->debug_text("acl_query_array(): ARO Array must be passed");
 297                         return false;
 298                 }
 299
 300                 foreach($aro_array as $aro_section_value => $aro_value_array) {
 301                         foreach ($aro_value_array as $aro_value) {
 302                                 $this->debug_text("acl_query_array(): ARO Section Value: $aro_section_value ARO VALUE: $aro_value");
 303
 304                                 if( $this->acl_check($aco_section_value, $aco_value, $aro_section_value, $aro_value) ) {
 305                                         $this->debug_text("acl_query_array(): ACL_CHECK True");
 306                                         $retarr[$aro_section_value][] = $aro_value;
 307                                 } else {
 308                                         $this->debug_text("acl_query_array(): ACL_CHECK False");
 309                                 }
 310                         }
 311                 }
 312
 313                 return $retarr;
 314
 315         }
 316
 317         /**
 318         * The Main function that does the actual ACL lookup.
 319         *
 320         * @param string The ACO section value
 321         * @param string The ACO value
 322         * @param string The ARO section value
 323         * @param string The ARO value
 324         * @param string The AXO section value (optional)
 325         * @param string The AXO value (optional)
 326         * @param string The value of the ARO group (optional)
 327         * @param string The value of the AXO group (optional)
 328         * @param boolean Debug the operation if true (optional)
 329         * @param boolean Option to return all applicable ACL's rather than just one. (optional) (Added by OpenEMR)
 330         * @return array Returns as much information as possible about the ACL so other functions can trim it down and omit unwanted data.
 331         */
 332         function acl_query($aco_section_value, $aco_value, $aro_section_value, $aro_value, $axo_section_value=NULL, $axo_value=NULL, $root_aro_group=NULL, $root_axo_group=NULL, $debug=NULL, $return_all=FALSE) {
 333
 334                 $cache_id = 'acl_query_'.$aco_section_value.'-'.$aco_value.'-'.$aro_section_value.'-'.$aro_value.'-'.$axo_section_value.'-'.$axo_value.'-'.$root_aro_group.'-'.$root_axo_group.'-'.$debug.'-'.$return_all;
 335
 336                 $retarr = $this->get_cache($cache_id);
 337
 338                 if (!$retarr) {
 339                         /*
 340                          * Grab all groups mapped to this ARO/AXO
 341                          */
 342                         $aro_group_ids = $this->acl_get_groups($aro_section_value, $aro_value, $root_aro_group, 'ARO');
 343
 344                         if (is_array($aro_group_ids) AND !empty($aro_group_ids)) {
 345                                 $sql_aro_group_ids = implode(',', $aro_group_ids);
 346                         }
 347
 348                         if ($axo_section_value != '' AND $axo_value != '') {
 349                                 $axo_group_ids = $this->acl_get_groups($axo_section_value, $axo_value, $root_axo_group, 'AXO');
 350
 351                                 if (is_array($axo_group_ids) AND !empty($axo_group_ids)) {
 352                                         $sql_axo_group_ids = implode(',', $axo_group_ids);
 353                                 }
 354                         }
 355
 356                         /*
 357                          * This query is where all the magic happens.
 358                          * The ordering is very important here, as well very tricky to get correct.
 359                          * Currently there can be  duplicate ACLs, or ones that step on each other toes. In this case, the ACL that was last updated/created
 360                          * is used; unless the $return_all parameter is set to TRUE, then will return the entire array of applicable ACL information (this
 361                          * option was added by OpenEMR)
 362                          *
 363                          * This is probably where the most optimizations can be made.
 364                          */
 365
 366                         $order_by = array();
 367
 368                         $query = '
 369                                         SELECT          a.id,a.allow,a.return_value
 370                                         FROM            '. $this->_db_table_prefix .'acl a
 371                                         LEFT JOIN       '. $this->_db_table_prefix .'aco_map ac ON ac.acl_id=a.id';
 372
 373                         if ($aro_section_value != $this->_group_switch) {
 374                                 $query .= '
 375                                         LEFT JOIN       '. $this->_db_table_prefix .'aro_map ar ON ar.acl_id=a.id';
 376                         }
 377
 378                         if ($axo_section_value != $this->_group_switch) {
 379                                 $query .= '
 380                                         LEFT JOIN       '. $this->_db_table_prefix .'axo_map ax ON ax.acl_id=a.id';
 381                         }
 382
 383                         /*
 384                          * if there are no aro groups, don't bother doing the join.
 385                          */
 386                         if (isset($sql_aro_group_ids)) {
 387                                 $query .= '
 388                                         LEFT JOIN       '. $this->_db_table_prefix .'aro_groups_map arg ON arg.acl_id=a.id
 389                                         LEFT JOIN       '. $this->_db_table_prefix .'aro_groups rg ON rg.id=arg.group_id';
 390                         }
 391
 392                         // this join is necessary to weed out rules associated with axo groups
 393                         $query .= '
 394                                         LEFT JOIN       '. $this->_db_table_prefix .'axo_groups_map axg ON axg.acl_id=a.id';
 395
 396                         /*
 397                          * if there are no axo groups, don't bother doing the join.
 398                          * it is only used to rank by the level of the group.
 399                          */
 400                         if (isset($sql_axo_group_ids)) {
 401                                 $query .= '
 402                                         LEFT JOIN       '. $this->_db_table_prefix .'axo_groups xg ON xg.id=axg.group_id';
 403                         }
 404
 405                         //Move the below line to the LEFT JOIN above for PostgreSQL's sake.
 406                         //AND   ac.acl_id=a.id
 407                         $query .= '
 408                                         WHERE           a.enabled=1
 409                                                 AND             (ac.section_value='. $this->db->quote($aco_section_value) .' AND ac.value='. $this->db->quote($aco_value) .')';
 410
 411                         // if we are querying an aro group
 412                         if ($aro_section_value == $this->_group_switch) {
 413                                 // if acl_get_groups did not return an array
 414                                 if ( !isset ($sql_aro_group_ids) ) {
 415                                         $this->debug_text ('acl_query(): Invalid ARO Group: '. $aro_value);
 416                                         return FALSE;
 417                                 }
 418
 419                                 $query .= '
 420                                                 AND             rg.id IN ('. $sql_aro_group_ids .')';
 421
 422                                 $order_by[] = '(rg.rgt-rg.lft) ASC';
 423                         } else {
 424                                 $query .= '
 425                                                 AND             ((ar.section_value='. $this->db->quote($aro_section_value) .' AND ar.value='. $this->db->quote($aro_value) .')';
 426
 427                                 if ( isset ($sql_aro_group_ids) ) {
 428                                         $query .= ' OR rg.id IN ('. $sql_aro_group_ids .')';
 429
 430                                         $order_by[] = '(CASE WHEN ar.value IS NULL THEN 0 ELSE 1 END) DESC';
 431                                         $order_by[] = '(rg.rgt-rg.lft) ASC';
 432                                 }
 433
 434                                 $query .= ')';
 435                         }
 436
 437
 438                         // if we are querying an axo group
 439                         if ($axo_section_value == $this->_group_switch) {
 440                                 // if acl_get_groups did not return an array
 441                                 if ( !isset ($sql_axo_group_ids) ) {
 442                                         $this->debug_text ('acl_query(): Invalid AXO Group: '. $axo_value);
 443                                         return FALSE;
 444                                 }
 445
 446                                 $query .= '
 447                                                 AND             xg.id IN ('. $sql_axo_group_ids .')';
 448
 449                                 $order_by[] = '(xg.rgt-xg.lft) ASC';
 450                         } else {
 451                                 $query .= '
 452                                                 AND             (';
 453
 454                                 if ($axo_section_value == '' AND $axo_value == '') {
 455                                         $query .= '(ax.section_value IS NULL AND ax.value IS NULL)';
 456                                 } else {
 457                                         $query .= '(ax.section_value='. $this->db->quote($axo_section_value) .' AND ax.value='. $this->db->quote($axo_value) .')';
 458                                 }
 459
 460                                 if (isset($sql_axo_group_ids)) {
 461                                         $query .= ' OR xg.id IN ('. $sql_axo_group_ids .')';
 462
 463                                         $order_by[] = '(CASE WHEN ax.value IS NULL THEN 0 ELSE 1 END) DESC';
 464                                         $order_by[] = '(xg.rgt-xg.lft) ASC';
 465                                 } else {
 466                                         $query .= ' AND axg.group_id IS NULL';
 467                                 }
 468
 469                                 $query .= ')';
 470                         }
 471
 472                         /*
 473                          * The ordering is always very tricky and makes all the difference in the world.
 474                          * Order (ar.value IS NOT NULL) DESC should put ACLs given to specific AROs
 475                          * ahead of any ACLs given to groups. This works well for exceptions to groups.
 476                          * If the $return_all parameter is set to TRUE, then will return the entire
 477                          * array of applicable ACL information (this option was added by OpenEMR)
 478                          */
 479
 480                         $order_by[] = 'a.updated_date DESC';
 481
 482                         $query .= '
 483                                         ORDER BY        '. implode (',', $order_by) . '
 484                                         ';
 485
 486                         // we are only interested in the first row unless $return_all is set
 487                         if ($return_all) {
 488                                 $rs = $this->db->Execute($query);
 489                         }
 490                         else {
 491                                 $rs = $this->db->SelectLimit($query, 1);
 492                         }
 493
 494                         if (!is_object($rs)) {
 495                                 $this->debug_db('acl_query');
 496                                 return FALSE;
 497                         }
 498
 499                         if ($return_all) {
 500                                 while ($arr = $rs->FetchRow()) {
 501                                         $row[] = $arr;
 502                                 }
 503                         }
 504                         else {
 505                                 $row = $rs->FetchRow();
 506                         }
 507
 508
 509                         /*
 510                          * Return ACL ID. This is the key to "hooking" extras like pricing assigned to ACLs etc... Very useful.
 511                          */
 512                         if (isset($row) && is_array($row)) {
 513
 514                                 if ($return_all) {
 515                                         foreach ($row as $single_row) {
 516                                                 $allow = FALSE;
 517                                                 if ( isset($single_row[1]) AND $single_row[1] == 1 ) {
 518                                                         $allow = TRUE;
 519                                                 }
 520                                                 $retarr[] = array('acl_id' => &$single_row[0], 'return_value' => &$single_row[2], 'allow' => $allow);
 521                                         }
 522                                 }
 523                                 else {
 524                                         $allow = FALSE;
 525                                         if ( isset($row[1]) AND $row[1] == 1 ) {
 526                                                 $allow = TRUE;
 527                                         }
 528                                         $retarr = array('acl_id' => &$row[0], 'return_value' => &$row[2], 'allow' => $allow);
 529                                 }
 530                         } else {
 531                                 if ($return_all) {
 532                                         // Permission denied.
 533                                         $retarr[] = array('acl_id' => NULL, 'return_value' => NULL, 'allow' => FALSE);
 534                                 }
 535                                 else {
 536                                         // Permission denied.
 537                                         $retarr = array('acl_id' => NULL, 'return_value' => NULL, 'allow' => FALSE);
 538                                 }
 539                         }
 540
 541                         /*
 542                          * Return the query that we ran if in debug mode.
 543                          */
 544                         if ($debug == TRUE) {
 545                                 $retarr['query'] = &$query;
 546                         }
 547
 548                         //Cache data.
 549                         $this->put_cache($retarr, $cache_id);
 550                 }
 551
 552                 if ($return_all)
 553                 {
 554                         $this->debug_text("<b>acl_query():</b> ACO Section: $aco_section_value ACO Value: $aco_value ARO Section: $aro_section_value ARO Value $aro_value ACL ID: OMITTED due to return_all");
 555                 }
 556                 else
 557                 {
 558                         $this->debug_text("<b>acl_query():</b> ACO Section: $aco_section_value ACO Value: $aco_value ARO Section: $aro_section_value ARO Value $aro_value ACL ID: ". $retarr['acl_id'] .' Result: '. $retarr['allow']);
 559                 }
 560
 561                 return $retarr;
 562         }
 563
 564         /**
 565         * Grabs all groups mapped to an ARO. You can also specify a root_group for subtree'ing.
 566         * @param string The section value or the ARO or ACO
 567         * @param string The value of the ARO or ACO
 568         * @param integer The group id of the group to start at (optional)
 569         * @param string The type of group, either ARO or AXO (optional)
 570         */
 571         function acl_get_groups($section_value, $value, $root_group=NULL, $group_type='ARO') {
 572
 573                 switch(strtolower($group_type)) {
 574                         case 'axo':
 575                                 $group_type = 'axo';
 576                                 $object_table = $this->_db_table_prefix .'axo';
 577                                 $group_table = $this->_db_table_prefix .'axo_groups';
 578                                 $group_map_table = $this->_db_table_prefix .'groups_axo_map';
 579                                 break;
 580                         default:
 581                                 $group_type = 'aro';
 582                                 $object_table = $this->_db_table_prefix .'aro';
 583                                 $group_table = $this->_db_table_prefix .'aro_groups';
 584                                 $group_map_table = $this->_db_table_prefix .'groups_aro_map';
 585                                 break;
 586                 }
 587
 588                 //$profiler->startTimer( "acl_get_groups()");
 589
 590                 //Generate unique cache id.
 591                 $cache_id = 'acl_get_groups_'.$section_value.'-'.$value.'-'.$root_group.'-'.$group_type;
 592
 593                 $retarr = $this->get_cache($cache_id);
 594
 595                 if (!$retarr) {
 596
 597                         // Make sure we get the groups
 598                         $query = '
 599                                         SELECT          DISTINCT g2.id';
 600
 601                         if ($section_value == $this->_group_switch) {
 602                                 $query .= '
 603                                         FROM            ' . $group_table . ' g1,' . $group_table . ' g2';
 604
 605                                 $where = '
 606                                         WHERE           g1.value=' . $this->db->quote( $value );
 607                         } else {
 608                                 $query .= '
 609                                         FROM            '. $object_table .' o,'. $group_map_table .' gm,'. $group_table .' g1,'. $group_table .' g2';
 610
 611                                 $where = '
 612                                         WHERE           (o.section_value='. $this->db->quote($section_value) .' AND o.value='. $this->db->quote($value) .')
 613                                                 AND             gm.'. $group_type .'_id=o.id
 614                                                 AND             g1.id=gm.group_id';
 615                         }
 616
 617                         /*
 618                          * If root_group_id is specified, we have to narrow this query down
 619                          * to just groups deeper in the tree then what is specified.
 620                          * This essentially creates a virtual "subtree" and ignores all outside groups.
 621                          * Useful for sites like sourceforge where you may seperate groups by "project".
 622                          */
 623                         if ( $root_group != '') {
 624                                 //It is important to note the below line modifies the tables being selected.
 625                                 //This is the reason for the WHERE variable.
 626                                 $query .= ','. $group_table .' g3';
 627
 628                                 $where .= '
 629                                                 AND             g3.value='. $this->db->quote( $root_group ) .'
 630                                                 AND             ((g2.lft BETWEEN g3.lft AND g1.lft) AND (g2.rgt BETWEEN g1.rgt AND g3.rgt))';
 631                         } else {
 632                                 $where .= '
 633                                                 AND             (g2.lft <= g1.lft AND g2.rgt >= g1.rgt)';
 634                         }
 635
 636                         $query .= $where;
 637
 638                         // $this->debug_text($query);
 639                         $rs = $this->db->Execute($query);
 640
 641                         if (!is_object($rs)) {
 642                                 $this->debug_db('acl_get_groups');
 643                                 return FALSE;
 644                         }
 645
 646                         $retarr = array();
 647
 648                         //Unbuffered query?
 649                         while (!$rs->EOF) {
 650                                 $retarr[] = reset($rs->fields);
 651                                 $rs->MoveNext();
 652                         }
 653
 654                         //Cache data.
 655                         $this->put_cache($retarr, $cache_id);
 656                 }
 657
 658                 return $retarr;
 659         }
 660
 661         /**
 662         * Uses PEAR's Cache_Lite package to grab cached arrays, objects, variables etc...
 663         * using unserialize() so it can handle more then just text string.
 664         * @param string The id of the cached object
 665         * @return mixed The cached object, otherwise FALSE if the object identifier was not found
 666         */
 667         function get_cache($cache_id) {
 668
 669                 if ( $this->_caching == TRUE ) {
 670                         $this->debug_text("get_cache(): on ID: $cache_id");
 671
 672                         if ( is_string($this->Cache_Lite->get($cache_id) ) ) {
 673                                 return unserialize($this->Cache_Lite->get($cache_id) );
 674                         }
 675                 }
 676
 677                 return false;
 678         }
 679
 680         /**
 681         * Uses PEAR's Cache_Lite package to write cached arrays, objects, variables etc...
 682         * using serialize() so it can handle more then just text string.
 683         * @param mixed A variable to cache
 684         * @param string The id of the cached variable
 685         */
 686         function put_cache($data, $cache_id) {
 687
 688                 if ( $this->_caching == TRUE ) {
 689                         $this->debug_text("put_cache(): Cache MISS on ID: $cache_id");
 690
 691                         return $this->Cache_Lite->save(serialize($data), $cache_id);
 692                 }
 693
 694                 return false;
 695         }
 696 }
 697 ?>