gosa-core/plugins/admin/users/class_divListUsers.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 divListUsers extends MultiSelectWindow
  24 {
  25
  26   /* Current base */
  27   var $selectedBase       = "";
  28   var $departments        = array();
  29
  30   /* Regex */
  31   var $Regex              = "*";
  32
  33   /* CheckBoxes */
  34   var $ShowTemplates ;
  35   var $ShowFunctionalUsers;
  36   var $ShowUnixUsers;
  37   var $ShowMailUsers;
  38   var $ShowSambaUsers;
  39   var $ShowProxyUsers;
  40
  41   /* Subsearch checkbox */
  42   var $SubSearch              = false;
  43
  44   var $parent             ;
  45   var $ui                 ;
  46
  47   function divListUsers (&$config,$parent)
  48   {
  49     MultiSelectWindow::MultiSelectWindow($config, "Users", "users");
  50
  51     $this->parent       = $parent;
  52     $this->ui           = get_userinfo();
  53
  54     /* Set list strings */
  55     $this->SetTitle(_("List of users"));
  56     $this->SetSummary(_("List of users"));
  57
  58     /* Result page will look like a headpage */
  59     $this->SetHeadpageMode();
  60
  61     $this->EnableAplhabet   (true);
  62
  63     /* Disable buttonsm */
  64     $this->EnableCloseButton(false);
  65     $this->EnableSaveButton (false);
  66
  67     /* Dynamic action col, depending on snapshot icons */
  68     $action_col_size = 122;
  69     if($this->parent->snapshotEnabled()){
  70       $action_col_size += 38;
  71     }
  72
  73     /* Toggle all selected / deselected */
  74     $chk = "<input type='checkbox' id='select_all' name='select_all' title='"._("Select all")."'
  75                onClick='toggle_all_(\"^item_selected_[0-9]*$\",\"select_all\");' >";
  76
  77     /* set Page header */
  78     $this->AddHeader(array("string"=> $chk,          "attach"=>"style='width:20px;'"));
  79     $this->AddHeader(array("string"=> "&nbsp;",          "attach"=>"style='width:20px;'"));
  80     $this->AddHeader(array("string"=>_("Username")." / "._("Department")));
  81     $this->AddHeader(array("string"=>_("Properties"),   "attach" => "style='width:166px;'"));
  82     $this->AddHeader(array("string"=>_("Actions"),      "attach" => "style='width:".$action_col_size."px;border-right:0px;text-align:right;'"));
  83
  84     $this->AddCheckBox("ShowTemplates"      ,msgPool::selectToView(_("Template"))             ,sprintf(_("Show %s"),_("templates")), false);
  85     $this->AddCheckBox("ShowFunctionalUsers",msgPool::selectToView(_("GOsa object"),"enabled"),sprintf(_("Show %s"),_("functional users")), true);
  86     $this->AddCheckBox("ShowUnixUsers"      ,msgPool::selectToView(_("Posix"),"enabled")      ,sprintf(_("Show %s"),_("POSIX users")), true);
  87     $this->AddCheckBox("ShowMailUsers"      ,msgPool::selectToView(_("Mail"),"enabled")       ,sprintf(_("Show %s"),_("mail users")), true);
  88     $this->AddCheckBox("ShowSambaUsers"     ,msgPool::selectToView(_("Samba"),"enabled")      ,sprintf(_("Show %s"),_("samba users")), true);
  89     $this->AddCheckBox("ShowProxyUsers"     ,msgPool::selectToView(_("Proxy"),"enabled")      ,sprintf(_("Show %s"),_("proxy users")), true);
  90
  91     /* Add SubSearch checkbox */
  92     $this->AddCheckBox(SEPERATOR);
  93     $this->AddCheckBox("SubSearch",  msgPool::selectToView("","subsearch"), msgPool::selectToView("","subsearch_small"), false);
  94
  95     /*                  Name                 ,Text                              ,Default  , Connect with alphabet  */
  96     $this->AddRegex   ("Regex",     _("Display users matching"),"*" , true);
  97   }
  98
  99
 100   function GenHeader()
 101   {
 102     /* Prepare departments,
 103        which are shown in the listbox on top of the listbox
 104      */
 105     $options= "";
 106
 107     /* Get all departments within this subtree */
 108     $base = $this->config->current['BASE'];
 109
 110     /* Add base */
 111     $tmp = array();
 112     $tmp[] = array("dn"=>$this->config->current['BASE']);
 113     $tmp=  array_merge($tmp,get_list("(&(|(ou=*)(description=*))(objectClass=gosaDepartment))", $this->module, $base,
 114                     array("ou", "description"), GL_SIZELIMIT | GL_SUBSEARCH));
 115
 116     $deps = array();
 117     foreach($tmp as $tm){
 118       $deps[$tm['dn']] = $tm['dn'];
 119     }
 120
 121
 122     /* Load possible departments */
 123     $ui= get_userinfo();
 124     $tdeps= $ui->get_module_departments("users");
 125     $ids = $this->config->idepartments;
 126     $first = "";
 127     $found = FALSE;
 128     foreach($ids as $dep => $name){
 129       if(isset($deps[$dep]) && in_array_ics($dep, $tdeps)){
 130
 131         /* Keep first base dn in mind, we could need this
 132          *  info if no valid base was found
 133          */
 134         if(empty($first)) {
 135           $first = $dep['dn'];
 136         }
 137
 138         $value = $ids[$dep];
 139         if ($this->selectedBase == $dep){
 140           $found = TRUE;
 141           $options.= "<option selected='selected' value='".$dep."'>$value</option>";
 142         } else {
 143           $options.= "<option value='".$dep."'>$value</option>";
 144         }
 145       }
 146     }
 147
 148     /* The currently used base is not visible with your acl setup.
 149      * Set base to first useable base.
 150      */
 151     if(!$found){
 152       $this->selectedBase = $first;
 153     }
 154
 155     /* Get copy & paste icon */
 156     $acl      = $ui->get_permissions($this->selectedBase,"users/user");
 157     $acl_all  = $ui->has_complete_category_acls($this->selectedBase,"users");
 158
 159     /* Add default header */
 160     $listhead = MultiSelectWindow::get_default_header();
 161     $listhead .=
 162       _("Base")."&nbsp;<select name='CurrentMainBase' onChange='mainform.submit()' class='center'>$options</select>".
 163       " <input class='center' type='image' src='images/lists/submit.png' align='middle'
 164       title='"._("Submit department")."' name='submit_department' alt='".  _("Submit")."'>&nbsp;";
 165
 166
 167     /* Create Layers menu */
 168     $s  = ".|"._("Actions")."|\n";
 169
 170     /* Append create options */
 171     if(preg_match("/c/",$acl)) {
 172       $s .= "..|<img src='images/lists/new.png' alt='' border='0' class='center'>".
 173         "&nbsp;"._("Create")."|\n";
 174       $s.= "...|<input class='center' type='image' src='images/list_new_user.png' alt=''>".
 175         "&nbsp;"._("User")."|user_new|\n";
 176       $s.= "...|<input class='center' type='image' src='images/lists/new.png' alt=''>".
 177         "&nbsp;"._("Template")."|user_tplnew|\n";
 178     }
 179
 180     /* Multiple options */
 181     $s.= "..|---|\n";
 182     $s.= "..|<img src='images/lists/edit.png' alt='' border='0' class='center'>".
 183       "&nbsp;"._("Edit")."|"."multiple_edit|\n";
 184     $s.= "..|<img src='images/list_password.png' alt='' border='0' class='center'>".
 185       "&nbsp;"._("Change password")."|"."multiple_password_change|\n";
 186     $s.= "..|<img src='images/lists/trash.png' alt='' border='0' class='center'>".
 187       "&nbsp;"._("Remove")."|"."remove_multiple|\n";
 188     $s.= "..|<img src='images/wizard.png' alt='' border='0' class='center'>".
 189       "&nbsp;"._("Apply template")."|"."templatize_multiple|\n";
 190
 191     /* Add event tag */
 192     if(class_available("DaemonEvent")){
 193       $events  = DaemonEvent::get_event_types(USER_EVENT);
 194       if(count($events['BY_CLASS'])){
 195         $s.= "..|---|\n";
 196         foreach($events['BY_CLASS'] as $name => $event){
 197           $s.= "..|".$event['MenuImage']."&nbsp;".$event['s_Menu_Name']."|event_".$name."\n";
 198         }
 199       }
 200     }
 201
 202
 203     if(is_object($this->parent->CopyPasteHandler) && preg_match("/r/",$acl_all)){
 204       $s.= "..|---|\n";
 205       $s.= "..|<img src='images/lists/copy.png' alt='' border='0' class='center'>".
 206         "&nbsp;"._("Copy")."|"."multiple_copy_systems|\n";
 207     }
 208     if(is_object($this->parent->CopyPasteHandler) && preg_match("/(r.*d|d.*r)/",$acl_all)){
 209       $s.= "..|<img src='images/lists/cut.png' alt='' border='0' class='center'>".
 210         "&nbsp;"._("Cut")."|"."multiple_cut_systems|\n";
 211     }
 212
 213     /* Copy & paste icons */
 214     if(is_object($this->parent->CopyPasteHandler) && $this->parent->CopyPasteHandler->entries_queued()){
 215       $img = "<img border='0' class='center' src='images/lists/paste.png' alt=''>";
 216       $s.="..|".$img."&nbsp;"._("Paste")."|editPaste|\n";
 217     }else{
 218       $img = "<img border='0' class='center' src='images/lists/paste-grey.png' alt=''>";
 219       $s.="..|".$img."&nbsp;"._("Paste")."\n";
 220     }
 221
 222     /* Add snapshot icons */
 223     if(preg_match("/(c.*w|w.*c)/",$acl_all)){
 224       $s .= "..|---|\n";
 225       $s .= $this->get_snapshot_header(TRUE);
 226     }
 227
 228     $this->SetDropDownHeaderMenu($s);
 229     $this->SetListHeader($listhead);
 230   }
 231
 232   /* so some basic settings */
 233   function execute()
 234   {
 235     $this->ClearElementsList();
 236     $this->GenHeader();
 237   }
 238
 239   function setEntries($list)
 240   {
 241     /********************
 242       Variable init
 243      ********************/
 244
 245     $num_users      = 0;
 246     $num_templates  = 0;
 247
 248     /* Variable initialation */
 249     $enviro     = $posix = $maila = $faxac = $samba = $netatalk = "";
 250     $empty      = "<img class='center' src='images/empty.png' style='width:16px;height:16px;' alt='-'>";
 251     $userimg    = "<img class='center' src='images/select_user.png' alt='User' title='%s'>";
 252     $tplimg     = "<img class='center' src='images/select_template.png' alt='Template' title='%s'>";
 253     $editlink   = "<a href='?plug=".validate($_GET['plug'])."&amp;id=%s&amp;act=edit_entry'>%s</a>";
 254
 255     /* Dynamic action col, depending on snapshot icons */
 256     $action_col_size = 122;
 257     if($this->parent->snapshotEnabled()){
 258       $action_col_size += 38;
 259     }
 260
 261     /* Possilbe objectClass image combinations */
 262     $possibleAccounts = array(
 263             "posixAccount"    => array("VAR"=>"posix"     ,"IMG"=>"posiximg"),
 264             "gotoEnvironment" => array("VAR"=>"enviro"    ,"IMG"=>"eviroimg"),
 265             "gosaMailAccount" => array("VAR"=>"maila"     ,"IMG"=>"mailimg"),
 266             "goFaxAccount"    => array("VAR"=>"faxac"     ,"IMG"=>"faximg"),
 267             "sambaSamAccount" => array("VAR"=>"samba"     ,"IMG"=>"sambaimg"),
 268             "apple-user"      => array("VAR"=>"netatalk"  ,"IMG"=>"netatalkimg"));
 269
 270      /* Pictures for Extensions */
 271     $usrimg   ="<input class='center' type='image' src='images/select_user.png' alt='"._("GOsa")."'
 272                     name='user_edit_%KEY%-user' title='"._("Edit generic properties")."'>";
 273     $posiximg = "<input class='center' type='image' src='images/penguin.png' alt='"._("Posix")."'
 274                     name='user_edit_%KEY%-posixAccount' title='"._("Edit UNIX properties")."'>";
 275     $eviroimg = "<input class='center' type='image' src='images/smallenv.png' alt='"._("Environment")."'
 276                     name='user_edit_%KEY%-environment' title='"._("Edit environment properties")."'>";
 277     $mailimg  = "<input class='center' type='image' src='images/mailto.png' alt='"._("Mail")."'
 278                     name='user_edit_%KEY%-mailAccount' title='"._("Edit mail properties")."'>";
 279     $fonimg   = "<input class='center' type='image' src='images/%image%' alt='"._("Phone")."'
 280                     name='user_edit_%KEY%-phoneAccount' title='"._("Edit phone properties")."%title%'>";
 281     $faximg   = "<input class='center' type='image' src='images/fax_small.png' alt='"._("Fax")."'
 282                     name='user_edit_%KEY%-gofaxAccount' title='"._("Edit fax properies")."'>";
 283     $sambaimg = "<input class='center' type='image' src='images/select_winstation.png' alt='"._("Samba")."'
 284                     name='user_edit_%KEY%-sambaAccount' title='"._("Edit samba properties")."'>";
 285     $netatalkimg = "<input class='center' type='image' src='images/select_netatalk.png' alt='"._("Netatalk")."'
 286                     name='user_edit_%KEY%-netatalk' title='"._("Edit netatalk properties")."'>";
 287     $tplcreateuserimg  = "<input type='image' class='center' src='images/lists/new.png' alt='"._("Create user from template")."'
 288                     name='userfrom_tpl_%KEY%' title='"._("Create user with this template")."'>";
 289
 290     /********************
 291       END :: Variable init
 292      ********************/
 293
 294
 295     /********************
 296       Append entries to divlist
 297      ********************/
 298
 299     $ui = get_userinfo();
 300
 301     // Test Every Entry and generate divlist Array
 302     foreach($list as $key => $val){
 303
 304       /* Create action icons */
 305       $action= "";
 306
 307       /* Add copy & cut icons */
 308       $acl      = $ui->get_permissions($val['dn'],"users/user");
 309       $acl_all  = $ui->has_complete_category_acls($val['dn'],"users");
 310
 311       if(preg_match("/(r.*d|r.*d)/",$acl_all) && $this->parent->CopyPasteHandler){
 312         $action .= "<input class='center' type='image'
 313           src='images/lists/cut.png' alt='"._("cut")."' name='cut_%KEY%' title='"._("Cut this entry")."'>&nbsp;";
 314       }else{
 315         $action.="<img src='images/empty.png' alt=' ' class='center'>&nbsp;";
 316       }
 317
 318       if(preg_match("/r/",$acl_all) && $this->parent->CopyPasteHandler){
 319         $action.= "<input class='center' type='image'
 320           src='images/lists/copy.png' alt='"._("copy")."' name='copy_%KEY%' title='"._("Copy this entry")."'>&nbsp;";
 321       }else{
 322         $action.="<img src='images/empty.png' alt=' ' class='center'>&nbsp;";
 323       }
 324
 325       /* Add deactivate status */
 326       $lock_status = "";
 327
 328       if(isset($val['userPassword'][0]) && preg_match("/^\{[^\}]/",$val['userPassword'][0])){
 329         if(preg_match("/^[^\}]*+\}!/",$val['userPassword'][0])){
 330           $lock_status = "<input class='center' type='image' src='images/lists/locked.png'
 331             alt='"._("inactive")."' name='toggle_lock_status_%KEY%'>";
 332         }else{
 333           $lock_status = "<input class='center' type='image' src='images/lists/unlocked.png'
 334             alt='"._("active")."' name='toggle_lock_status_%KEY%'>";
 335         }
 336       }else{
 337         $lock_status = "<img src='images/empty.png' alt=' ' class='center'>";
 338       }
 339
 340       /* Generate edit icon */
 341       $action.= "<input class='center' type='image' src='images/lists/edit.png' alt='"._("edit")."'
 342         name='user_edit_%KEY%' title='".msgPool::editButton(_("user"))."'>";
 343
 344       /* Add deactivate status if we are allowed to */
 345       if (preg_match("/w/",$ui->get_permissions($val['dn'],"users/password"))){
 346         $action.= $lock_status;
 347       }else{
 348         $action.="<img src='images/empty.png' alt=' ' class='center'>";
 349       }
 350
 351       /* Add Password change icon, if we are able to write users/password */
 352       if(!in_array_ics("gosaUserTemplate",$val['objectClass']) && preg_match("/w/",$ui->get_permissions($val['dn'],"users/password"))) {
 353         $action.= "<input class='center' type='image' src='images/list_password.png' alt='"._("password")."'
 354           name='user_chgpw_%KEY%' title='"._("Change password")."'>";
 355       }else{
 356         $action.= "<img class='center' src='images/empty.png' alt='&nbsp;'
 357           title='"._("Not allowed")."'>";
 358       }
 359
 360       /* Add snapshot icon */
 361       if(preg_match("/(r.*w|w.*r)/",$acl_all)){
 362         $action.= $this->GetSnapShotActions($val['dn']);
 363       }else{
 364         $action.="<img src='images/empty.png' alt=' ' class='center'>&nbsp;";
 365         $action.="<img src='images/empty.png' alt=' ' class='center'>&nbsp;";
 366       }
 367
 368       /* Add remove icon, if we are allowed to remove the current user */
 369       if(preg_match("/d/",$acl)) {
 370         $action.= "<input class='center' type='image' src='images/lists/trash.png' alt='"._("delete")."'
 371           name='user_del_%KEY%' title='"._("Delete user")."'>";
 372       }else{
 373         $action.= "<img class='center' src='images/empty.png' alt='&nbsp;'
 374           title='"._("Not allowed")."'>";
 375       }
 376
 377       /* Create phonaccopunt informationm, if conencted && is phoneAccount */
 378       if((in_array("goFonAccount"    ,$val['objectClass']))){
 379
 380         /* Set defaults */
 381         $fonac = preg_replace("/%image%/", "select_phone.png", $fonimg);
 382         $fonac = preg_replace("/%KEY%/", "$key", $fonac);
 383         $fonac = preg_replace("/%title%/", "", $fonac);
 384
 385       }else{
 386         $fonac=$empty;
 387       }
 388
 389       /* Set images for different types of objectClasses */
 390       foreach($possibleAccounts as $objectClass => $Settigns){
 391         if(in_array($objectClass ,$val['objectClass'])){
 392           $$Settigns['VAR'] = preg_replace("/%KEY%/", "$key", $$Settigns['IMG']);
 393         }else{
 394           $$Settigns['VAR'] = $empty;
 395         }
 396       }
 397
 398       /* Create userimg */
 399       if(in_array("gosaUserTemplate",$val['objectClass'])){
 400         $tpl                          = preg_replace("/%KEY%/", "$key", $tplimg);
 401         $s_img_create_from_template   = preg_replace("/%KEY%/", "$key", $tplcreateuserimg);
 402         $num_templates ++;
 403       }else{
 404         $s_img_create_from_template   = "";
 405         $tpl                          = $userimg;
 406         $num_users ++;
 407       }
 408
 409       /* Insert key into userimg */
 410       $usrimg2 = preg_replace("/%KEY%/", "$key", $usrimg);
 411
 412       // Generate caption for rows
 413       if (isset($val["sn"]) && isset($val["givenName"])){
 414         $display= $val["sn"][0].", ".$val["givenName"][0]." [".$val["uid"][0]."]";
 415       } else {
 416         $display= "[".$val["uid"][0]."]";
 417       }
 418
 419       /* Connect all images */
 420       $UseImg = $usrimg2."&nbsp;".$posix."&nbsp;".$enviro."&nbsp;".$maila."&nbsp;".$fonac."&nbsp;".$faxac."&nbsp;".$samba."&nbsp;".$netatalk;
 421
 422       /* Cutted objects should be displayed in light grey */
 423       if($this->parent->CopyPasteHandler){
 424         foreach($this->parent->CopyPasteHandler->queue as $queue_key => $queue_data){
 425           if($queue_data['dn'] == $val['dn']) {
 426             $display = "<font color='#999999'>".$display."</font>";
 427             break;
 428           }
 429         }
 430       }
 431
 432       /* Create each field */
 433       $field0 = array("string" => "<input type='checkbox' id='item_selected_".$key."' name='item_selected_".$key."'>" ,
 434                       "attach" => "style='width:20px;'");
 435       $field1 = array("string" => sprintf($tpl,$val['dn']), "attach" => "style='text-align:center;width:20px;'");
 436       $field2 = array("string" => sprintf($editlink,$key,$display), "attach" => "style='' title='".preg_replace('/ /', '&nbsp;', @LDAP::fix($val['dn']))."'");
 437       $field3 = array("string" => $UseImg, "attach" => "style='width:166px;'");
 438       $field4 = array("string" => $s_img_create_from_template.preg_replace("/%KEY%/", "$key", $action),
 439                       "attach" => "style='width:".$action_col_size."px;border-right:0px;    text-align:right;'");
 440       /* Add to list */
 441       $add = array($field0,$field1,$field2,$field3,$field4);
 442       $this->AddElement($add);
 443
 444       // Template or User
 445       if(in_array("gosaUserTemplate",$val['objectClass'])){
 446         $tpls[strtolower( $val['sn']['0'].$val['uid']['0'])]=$add;
 447       }else{
 448         $users[strtolower( $val['sn']['0'].$val['uid']['0'])]=$add;
 449       }
 450     }
 451
 452
 453     /* Create summary string for list footer */
 454     $num_deps=0;
 455     if(!$this->SubSearch){
 456       $num_deps = count($this->Added_Departments);
 457     }
 458     $num_users = count($list);
 459
 460     $num_user_str = _("Number of listed users");
 461     $num_dep_str = _("Number of listed departments");
 462
 463     $str = "<img class='center' src='images/select_user.png'
 464               title='".$num_user_str."' alt='".$num_user_str."'>&nbsp;".$num_users."&nbsp;&nbsp;&nbsp;&nbsp;";
 465     $str.= "<img class='center' src='images/lists/folder.png'
 466               title='".$num_dep_str."' alt='".$num_dep_str."'>&nbsp;".$num_deps."&nbsp;&nbsp;&nbsp;&nbsp;";
 467
 468     $this->set_List_Bottom_Info($str);
 469   }
 470
 471   function Save()
 472   {
 473     MultiSelectWindow :: Save();
 474   }
 475
 476   function save_object()
 477   {
 478     /* Save automatic created POSTs like regex, checkboxes */
 479     MultiSelectWindow::save_object();
 480   }
 481 }
 482 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 483 ?>