gosa-core/include/class_userinfo.inc

   1 <?php
   2 /*
   3  * This code is part of GOsa (http://www.gosa-project.org)
   4  * Copyright (C) 2003-2008 GONICUS GmbH
   5  *
   6  * ID: $$Id$$
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program 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
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 class userinfo
  24 {
  25   var $dn;
  26   var $ip;
  27   var $username;
  28   var $cn;
  29   var $uid;
  30   var $gidNumber= -1;
  31   var $language= "";
  32   var $config;
  33   var $gosaUnitTag= "";
  34   var $subtreeACL= array();
  35   var $ACL= array();
  36   var $ocMapping= array();
  37   var $groups= array();
  38   var $result_cache =array();
  39
  40   /* get acl's an put them into the userinfo object
  41      attr subtreeACL (userdn:components, userdn:component1#sub1#sub2,component2,...) */
  42   function userinfo(&$config, $userdn){
  43     $this->config= &$config;
  44     $ldap= $this->config->get_ldap_link();
  45     $ldap->cat($userdn,array('sn', 'givenName', 'uid', 'gidNumber', 'preferredLanguage', 'gosaUnitTag'));
  46     $attrs= $ldap->fetch();
  47
  48     if (isset($attrs['givenName'][0]) && isset($attrs['sn'][0])){
  49       $this->cn= $attrs['givenName'][0]." ".$attrs['sn'][0];
  50     } else {
  51       $this->cn= $attrs['uid'][0];
  52     }
  53     if (isset($attrs['gidNumber'][0])){
  54       $this->gidNumber= $attrs['gidNumber'][0];
  55     }
  56
  57     /* Assign user language */
  58     if (isset($attrs['preferredLanguage'][0])){
  59       $this->language= $attrs['preferredLanguage'][0];
  60     }
  61
  62     if (isset($attrs['gosaUnitTag'][0])){
  63       $this->gosaUnitTag= $attrs['gosaUnitTag'][0];
  64     }
  65
  66     $this->dn= $userdn;
  67     $this->uid= $attrs['uid'][0];
  68     $this->ip= $_SERVER['REMOTE_ADDR'];
  69
  70     /* Initialize ACL_CACHE */
  71     session::set('ACL_CACHE',array());
  72     $this->reset_acl_cache();
  73   }
  74
  75
  76   public function reset_acl_cache()
  77   {
  78     /* Initialize ACL_CACHE */
  79     session::set('ACL_CACHE',array());
  80   }
  81
  82   function loadACL()
  83   {
  84     $this->ACL= array();
  85     $this->groups= array();
  86     $this->result_cache =array();
  87     $this->reset_acl_cache();
  88     $ldap= $this->config->get_ldap_link();
  89     $ldap->cd($this->config->current['BASE']);
  90
  91     /* Get member groups... */
  92     $ldap->search("(&(objectClass=posixGroup)(memberUid=".$this->uid."))", array('dn'));
  93     while ($attrs= $ldap->fetch()){
  94       $this->groups[$attrs['dn']]= $attrs['dn'];
  95     }
  96
  97     /* Crawl through ACLs and move relevant to the tree */
  98     $ldap->search("(objectClass=gosaACL)", array('dn', 'gosaAclEntry'));
  99     $aclp= array();
 100     $aclc= array();
 101     while ($attrs= $ldap->fetch()){
 102
 103       /* Insert links in ACL array */
 104       $aclp[$attrs['dn']]= substr_count($attrs['dn'], ',');
 105       $aclc[$attrs['dn']]= array();
 106       $ol= array();
 107       for($i= 0; $i<$attrs['gosaAclEntry']['count']; $i++){
 108         $ol= array_merge($ol, @acl::explodeAcl($attrs['gosaAclEntry'][$i]));
 109       }
 110       $aclc[$attrs['dn']]= $ol;
 111     }
 112
 113     /* Resolve roles here.
 114      */
 115     foreach($aclc as $dn => $data){
 116       foreach($data as $prio => $aclc_value)  {
 117         if($aclc_value['type'] == "role"){
 118
 119           unset($aclc[$dn][$prio]);
 120
 121           $ldap->cat($aclc_value['acl'],array("gosaAclTemplate"));
 122           $attrs = $ldap->fetch();
 123
 124           if(isset($attrs['gosaAclTemplate'])){
 125             for($i= 0; $i<$attrs['gosaAclTemplate']['count']; $i++){
 126               $tmp = @acl::explodeAcl($attrs['gosaAclTemplate'][$i]);
 127
 128               foreach($tmp as $new_acl){
 129                 $new_acl['members'] = $aclc_value['members'];
 130                 $aclc[$dn][] =$new_acl;
 131               }
 132             }
 133           }
 134         }
 135       }
 136     }
 137
 138     /* ACL's read, sort for tree depth */
 139     asort($aclp);
 140
 141     /* Sort in tree order */
 142     foreach ($aclp as $dn => $acl){
 143       /* Check if we need to keep this ACL */
 144       foreach($aclc[$dn] as $idx => $type){
 145         $interresting= FALSE;
 146
 147         /* No members? This is good for all users... */
 148         if (!count($type['members'])){
 149           $interresting= TRUE;
 150         } else {
 151
 152           /* Inspect members... */
 153           foreach ($type['members'] as $grp => $grpdsc){
 154             /* Some group inside the members that is relevant for us? */
 155             if (in_array_ics(preg_replace('/^G:/', '', $grp), $this->groups)){
 156               $interresting= TRUE;
 157             }
 158
 159             /* User inside the members? */
 160             if (preg_replace('/^U:/', '', $grp) == $this->dn){
 161               $interresting= TRUE;
 162             }
 163           }
 164         }
 165
 166         if ($interresting){
 167           if (!isset($this->ACL[$dn])){
 168             $this->ACL[$dn]= array();
 169           }
 170           $this->ACL[$dn][$idx]= $type;
 171         }
 172       }
 173
 174     }
 175   }
 176
 177
 178   function get_category_permissions($dn, $category)
 179   {
 180     /* If we are forced to skip ACLs checks for the current user
 181         then return all permissions.
 182      */
 183     if($this->ignore_acl_for_current_user()){
 184       return("rwcdm");
 185     }
 186
 187     /* Get list of objectClasses and get the permissions for it */
 188     $acl= "";
 189     if (isset($this->ocMapping[$category])){
 190       foreach($this->ocMapping[$category] as $oc){
 191         $acl.= $this->get_permissions($dn, $category."/".$oc);
 192       }
 193     }else{
 194       trigger_error("ACL request for an invalid category (".$category.").");
 195     }
 196
 197     return ($acl);
 198   }
 199
 200
 201   /*! \brief Check if the given object (dn) is copyable
 202       @param  String The object dn
 203       @param  String The acl  category (e.g. users)
 204       @param  String The acl  class (e.g. user)
 205       @return Boolean   TRUE if the given object is copyable else FALSE
 206   */
 207   function is_copyable($dn, $object, $class)
 208   {
 209     return(preg_match("/r/",$this->has_complete_category_acls($dn, $object)));
 210   }
 211
 212
 213   /*! \brief Check if the given object (dn) is cutable
 214       @param  String The object dn
 215       @param  String The acl  category (e.g. users)
 216       @param  String The acl  class (e.g. user)
 217       @return Boolean   TRUE if the given object is cutable else FALSE
 218   */
 219   function is_cutable($dn, $object, $class)
 220   {
 221     $remove = preg_match("/d/",$this->get_permissions($dn,$object."/".$class));
 222     $read   = preg_match("/r/",$this->has_complete_category_acls($dn, $object));
 223     return($remove && $read);
 224   }
 225
 226
 227   /*! \brief  Checks if we are allowed to paste an object to the given destination ($dn)
 228       @param  String The destination dn
 229       @param  String The acl  category (e.g. users)
 230       @param  String The acl  class (e.g. user)
 231       @return Boolean   TRUE if we are allowed to paste an object.
 232   */
 233   function is_pasteable($dn, $object)
 234   {
 235     return(preg_match("/w/",$this->has_complete_category_acls($dn, $object)));
 236   }
 237
 238
 239   /*! \brief  Checks if we are allowed to restore a snapshot for the given dn.
 240       @param  String The destination dn
 241       @param  String The acl  category (e.g. users)
 242       @return Boolean   TRUE if we are allowed to restore a snapshot.
 243   */
 244   function allow_snapshot_restore($dn, $object)
 245   {
 246     if(!is_array($object)){
 247       $object = array($object);
 248     }
 249     $r = $w = $c = TRUE;
 250     foreach($object as $category){
 251       $w &= preg_match("/w/",$this->has_complete_category_acls($dn, $category));
 252       $c &= preg_match("/c/",$this->has_complete_category_acls($dn, $category));
 253       $r &= preg_match("/r/",$this->has_complete_category_acls($dn, $category));
 254 #     print_a(array($category => array($r.$w.$c)));
 255     }
 256     return($r && $w );
 257   }
 258
 259
 260   /*! \brief  Checks if we are allowed to create a snapshot of the given dn.
 261       @param  String The source dn
 262       @param  String The acl category (e.g. users)
 263       @return Boolean   TRUE if we are allowed to restore a snapshot.
 264   */
 265   function allow_snapshot_create($dn, $object)
 266   {
 267     if(!is_array($object)){
 268       $object = array($object);
 269     }
 270     $r = $w = $c = TRUE;
 271     foreach($object as $category){
 272       $w &= preg_match("/w/",$this->has_complete_category_acls($dn, $category));
 273       $c &= preg_match("/c/",$this->has_complete_category_acls($dn, $category));
 274       $r &= preg_match("/r/",$this->has_complete_category_acls($dn, $category));
 275 #      print_a(array($category => array($r.$w.$c)));
 276     }
 277     return($r) ;
 278   }
 279
 280
 281   function get_permissions($dn, $object, $attribute= "", $skip_write= FALSE)
 282   {
 283     /* If we are forced to skip ACLs checks for the current user
 284         then return all permissions.
 285      */
 286     if($this->ignore_acl_for_current_user()){
 287       return("rwcdm");
 288     }
 289
 290     /* Push cache answer? */
 291     $ACL_CACHE = &session::get('ACL_CACHE');
 292     if (isset($ACL_CACHE["$dn+$object+$attribute"])){
 293
 294       /* Remove write if needed */
 295       if ($skip_write){
 296         $ret = preg_replace('/w/', '', $ACL_CACHE["$dn+$object+$attribute"]);
 297       }else{
 298         $ret = $ACL_CACHE["$dn+$object+$attribute"];
 299       }
 300       return($ret);
 301     }
 302
 303     /* Get ldap object, for later filter checks
 304      */
 305     $ldap = $this->config->get_ldap_link();
 306
 307     $acl= array("r" => "", "w" => "", "c" => "", "d" => "", "m" => "", "a" => "");
 308
 309     /* Build dn array */
 310     $path= split(',', $dn);
 311     $path= array_reverse($path);
 312
 313     /* Walk along the path to evaluate the acl */
 314     $cpath= "";
 315     foreach ($path as $element){
 316
 317       /* Clean potential ACLs for each level */
 318       if(in_array($cpath,$this->config->departments)){
 319         $acl= $this->cleanACL($acl);
 320       }
 321
 322       if ($cpath == ""){
 323         $cpath= $element;
 324       } else {
 325         $cpath= $element.','.$cpath;
 326       }
 327
 328       if (isset($this->ACL[$cpath])){
 329
 330         /* Inspect this ACL, place the result into ACL */
 331         foreach ($this->ACL[$cpath] as $subacl){
 332
 333           /* Reset? Just clean the ACL and turn over to the next one... */
 334           if ($subacl['type'] == 'reset'){
 335             $acl= $this->cleanACL($acl, TRUE);
 336             continue;
 337           }
 338
 339           if($subacl['type'] == "role") {
 340             echo "role skipped";
 341             continue;
 342           }
 343
 344           /* With user filter */
 345           if (isset($subacl['filter']) && !empty($subacl['filter'])){
 346             $sdn = preg_replace("/^[^,]*+,/","",$dn);
 347             $ldap->cd($sdn);
 348             $ldap->ls($subacl['filter'],$sdn);
 349             if(!$ldap->count()){
 350               continue;
 351             }else{
 352               $found = FALSE;
 353               while($attrs = $ldap->fetch()){
 354                 if($attrs['dn'] == $dn){
 355                   $found = TRUE;
 356                   break;
 357                 }
 358               }
 359               if(!$found){
 360                 continue;
 361               }
 362             }
 363           }
 364
 365           /* Self ACLs?
 366            */
 367           if(isset($subacl['acl'][$object][0]) && preg_match("/s/",$subacl['acl'][$object][0]) && $dn != $this->dn){
 368             continue;
 369           }
 370
 371           /* If attribute is "", we want to know, if we've *any* permissions here...
 372               Merge global class ACLs [0] with attributes specific ACLs [attribute].
 373            */
 374           if ($attribute == "" && isset($subacl['acl'][$object])){
 375             foreach($subacl['acl'][$object] as $attr => $dummy){
 376               $acl= $this->mergeACL($acl, $subacl['type'], $subacl['acl'][$object][$attr]);
 377             }
 378             continue;
 379           }
 380
 381           /* Per attribute ACL? */
 382           if (isset($subacl['acl'][$object][$attribute])){
 383             $acl= $this->mergeACL($acl, $subacl['type'], $subacl['acl'][$object][$attribute]);
 384             continue;
 385           }
 386
 387           /* Per object ACL? */
 388           if (isset($subacl['acl'][$object][0])){
 389             $acl= $this->mergeACL($acl, $subacl['type'], $subacl['acl'][$object][0]);
 390             continue;
 391           }
 392
 393           /* Global ACL? */
 394           if (isset($subacl['acl']['all'][0])){
 395             $acl= $this->mergeACL($acl, $subacl['type'], $subacl['acl']['all'][0]);
 396             continue;
 397           }
 398         }
 399       }
 400     }
 401
 402     /* If the requested ACL is for a container object, then alter
 403         ACLs by applying cleanACL a last time.
 404      */
 405     if(in_array($dn,$this->config->departments)){
 406       $acl = $this->cleanACL($acl);
 407     }
 408
 409     /* Assemble string */
 410     $ret= "";
 411     foreach ($acl as $key => $value){
 412       if ($value !== ""){
 413         $ret.= $key;
 414       }
 415     }
 416
 417     $ACL_CACHE["$dn+$object+$attribute"]= $ret;
 418
 419     /* Remove write if needed */
 420     if ($skip_write){
 421       $ret= preg_replace('/w/', '', $ret);
 422     }
 423     return ($ret);
 424   }
 425
 426
 427   /* Extract all departments that are accessible (direct or 'on the way' to an
 428      accessible department) */
 429   function get_module_departments($module, $skip_self_acls = FALSE )
 430   {
 431
 432     /* If we are forced to skip ACLs checks for the current user
 433         then return all departments as valid.
 434      */
 435     if($this->ignore_acl_for_current_user()){
 436       return(array_keys($this->config->idepartments));
 437     }
 438
 439     /* Use cached results if possilbe */
 440     $ACL_CACHE = session::get('ACL_CACHE');
 441     if(isset($ACL_CACHE['MODULE_DEPARTMENTS'][serialize($module)])){
 442       return($ACL_CACHE['MODULE_DEPARTMENTS'][serialize($module)]);
 443     }
 444
 445     global $plist;
 446
 447     $objects= array();
 448     $deps= array();
 449
 450     /* Extract all relevant objects for this module from plist */
 451     foreach ($plist->info as $object => $info){
 452       if (!isset($info['plCategory'])){
 453         continue;
 454       }
 455       foreach ($info['plCategory'] as $idx => $data){
 456         if (preg_match('/^[0-9]+$/', $idx)){
 457           if ($data == $module){
 458             $objects[$object]= $object;
 459           }
 460         } else {
 461           if ($idx == $module){
 462             $objects[$object]= $object;
 463           }
 464         }
 465       }
 466     }
 467
 468     /* Search for per object ACLs.
 469      */
 470     $this->config->get_departments();
 471     $this->config->make_idepartments();
 472
 473     foreach($this->ACL as $dn => $infos){
 474       foreach($infos as $info){
 475         $found = FALSE;
 476         foreach($info['acl'] as $cat => $data){
 477
 478           /* Skip self acls?
 479            */
 480           if($skip_self_acls && preg_match("//s",$data['0'])) continue;
 481
 482           if(is_array($module)){
 483             foreach($module as $mod){
 484               if(preg_match("/^".normalizePreg($mod)."/",$cat)){
 485                 $found =TRUE;
 486                 break;
 487               }
 488             }
 489           }else{
 490             if(preg_match("/^".normalizePreg($module)."/",$cat)){
 491               $found =TRUE;
 492               break;
 493             }
 494           }
 495         }
 496
 497         if($found && !isset($this->config->idepartments[$dn])){
 498           while(!isset($this->config->idepartments[$dn]) && preg_match("/,/",$dn)){
 499             $dn = preg_replace("/^[^,]+,/","",$dn);
 500           }
 501           if(isset($this->config->idepartments[$dn])){
 502             $deps[] = $dn;
 503           }
 504         }
 505       }
 506     }
 507
 508     /* For all gosaDepartments */
 509     foreach ($this->config->departments as $dn){
 510       if(!is_array($module)){
 511         $module = array($module);
 512       }
 513       $acl = "";
 514       foreach($module as $mod){
 515         if(preg_match("/\//",$mod)){
 516           $acl.=  $this->get_permissions($dn,$mod);
 517         }else{
 518           $acl.=  $this->get_category_permissions($dn,$mod);
 519         }
 520       }
 521       if($acl !== "") $deps[] = $dn;
 522     }
 523
 524     $ACL_CACHE = &session::get('ACL_CACHE');
 525     $ACL_CACHE['MODULE_DEPARTMENTS'][serialize($module)] = $deps;
 526     return ($deps);
 527   }
 528
 529
 530   function mergeACL($acl, $type, $newACL)
 531   {
 532     if (strpos($newACL, 'w') !== FALSE && strpos($newACL, 'r') === FALSE){
 533       $newACL .= "r";
 534     }
 535
 536     foreach(str_split($newACL) as $char){
 537
 538       /* Ignore invalid characters */
 539       if (!preg_match('/[rwcdm]/', $char)){
 540         continue;
 541       }
 542
 543       /* Skip permanent and subtree entries */
 544       if (preg_match('/[sp]/', $acl[$char])){
 545         continue;
 546       }
 547
 548       switch ($type){
 549         case 'psub':
 550           $acl[$char]= 'p';
 551           break;
 552
 553         case 'sub':
 554           $acl[$char]= 's';
 555           break;
 556
 557         case 'one':
 558           $acl[$char]= 1;
 559           break;
 560
 561         case 'base':
 562           if ($acl[$char] != 1){
 563             $acl[$char]= 0;
 564           }
 565           break;
 566       }
 567     }
 568
 569     return ($acl);
 570   }
 571
 572
 573   function cleanACL($acl, $reset= FALSE)
 574   {
 575     foreach ($acl as &$value){
 576
 577       /* Reset removes everything but 'p' */
 578       if ($reset && $value != 'p'){
 579         $value= "";
 580         continue;
 581       }
 582
 583       /* Decrease tree level */
 584       if (is_int($value)){
 585         if ($value){
 586           $value--;
 587         } else {
 588           $value= "";
 589         }
 590       }
 591     }
 592
 593     return ($acl);
 594   }
 595
 596
 597   /* #FIXME This could be logical wrong or could be optimized in the future
 598      Return combined acls for a given category.
 599      All acls will be combined like boolean AND
 600       As example ('rwcdm' + 'rcd' + 'wrm'= 'r')
 601
 602      Results will be cached in $this->result_cache.
 603       $this->result_cache will be resetted if load_acls is called.
 604   */
 605   function has_complete_category_acls($dn,$category)
 606   {
 607     $acl    = "rwcdm";
 608     $types  = "rwcdm";
 609
 610     if(!is_string($category)){
 611       trigger_error("category must be string");
 612       $acl = "";
 613     }else{
 614       if(!isset($this->result_cache['has_complete_category_acls'][$dn][$category]))   {
 615         if (isset($this->ocMapping[$category])){
 616           foreach($this->ocMapping[$category] as $oc){
 617
 618             /* Skip objectClass '0' (e.g. users/0) get_permissions will ever return '' ??  */
 619             if($oc == "0") continue;
 620             $tmp =  $this->get_permissions($dn, $category."/".$oc);
 621             for($i = 0 ; $i < strlen($types); $i++) {
 622               if(!preg_match("/".$types[$i]."/",$tmp)){
 623                 $acl = preg_replace("/".$types[$i]."/","",$acl);
 624               }
 625             }
 626           }
 627         }else{
 628           trigger_error("Invalid type of category ".$category);
 629           $acl = "";
 630         }
 631         $this->result_cache['has_complete_category_acls'][$dn][$category] = $acl;
 632       }else{
 633         $acl = $this->result_cache['has_complete_category_acls'][$dn][$category];
 634       }
 635     }
 636     return($acl);
 637   }
 638
 639
 640   /*! \brief  Returns TRUE if the current user is configured in IGNORE_ACL=".." in your gosa.conf
 641       @param  Return Boolean TRUE if we have to skip ACL checks else FALSE.
 642    */
 643   function ignore_acl_for_current_user()
 644   {
 645     return(isset($this->config->current['IGNORE_ACL']) && $this->config->current['IGNORE_ACL'] == $this->dn);
 646   }
 647
 648 }
 649
 650 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 651 ?>