Code

Centralized copy & paste icon creation && permission checks
[gosa.git] / 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  */
23 class divListUsers extends MultiSelectWindow
24 {
26   /* Current base */
27   var $selectedBase       = "";
28   var $departments        = array();
30   /* Regex */
31   var $Regex              = "*";
33   /* CheckBoxes */
34   var $ShowTemplates ;
35   var $ShowFunctionalUsers;
36   var $ShowUnixUsers;
37   var $ShowMailUsers;
38   var $ShowSambaUsers;
39   var $ShowProxyUsers;
41   /* Subsearch checkbox */
42   var $SubSearch              = false;
44   var $parent             ;
45   var $ui                 ;
47   function divListUsers (&$config,$parent)
48   {
49     MultiSelectWindow::MultiSelectWindow($config, "Users", "users");
50     
51     $this->parent       = $parent;
52     $this->ui           = get_userinfo();
54     /* Set list strings */
55     $this->SetTitle(_("List of users"));
56     $this->SetSummary(_("List of users"));
58     /* Result page will look like a headpage */
59     $this->SetHeadpageMode();
61     $this->EnableAplhabet   (true);
62   
63     /* Disable buttonsm */
64     $this->EnableCloseButton(false);
65     $this->EnableSaveButton (false);
67     /* Dynamic action col, depending on snapshot icons */
68     $action_col_size = 122;
69     if($this->parent->snapshotEnabled()){
70       $action_col_size += 38;
71     }
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\");' >";
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);
91     /* Add SubSearch checkbox */
92     $this->AddCheckBox(SEPERATOR);
93     $this->AddCheckBox("SubSearch",  msgPool::selectToView("","subsearch"), msgPool::selectToView("","subsearch_small"), false);
95     /*                  Name                 ,Text                              ,Default  , Connect with alphabet  */
96     $this->AddRegex   ("Regex",     _("Display users matching"),"*" , true);
97   }
100   function GenHeader()
101   {
102     /* Prepare departments,
103        which are shown in the listbox on top of the listbox
104      */
105     $options= "";
107     /* Get all departments within this subtree */ 
108     $base = $this->config->current['BASE'];
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     }    
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)){
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         }
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     }
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     }
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");
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;";
167     /* Create Layers menu */
168     $s  = ".|"._("Actions")."|\n";
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     }
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";
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     }
202     $s .= $this->parent->get_copypaste_header($this->selectedBase,$this->module);
203     $s .= $this->parent->get_snapshot_header($this->selectedBase,$this->module);
205     $this->SetDropDownHeaderMenu($s);
206     $this->SetListHeader($listhead);
207   }
209   /* so some basic settings */
210   function execute()
211   {
212     $this->ClearElementsList();
213     $this->GenHeader();
214   }
216   function setEntries($list)
217   {
218     /********************
219       Variable init
220      ********************/
221     
222     $num_users      = 0;
223     $num_templates  = 0;
225     /* Variable initialation */
226     $enviro     = $posix = $maila = $faxac = $samba = $netatalk = "";
227     $empty      = "<img class='center' src='images/empty.png' style='width:16px;height:16px;' alt='-'>";
228     $userimg    = "<img class='center' src='images/select_user.png' alt='User' title='%s'>";
229     $tplimg     = "<img class='center' src='images/select_template.png' alt='Template' title='%s'>";
230     $editlink   = "<a href='?plug=".validate($_GET['plug'])."&amp;id=%s&amp;act=edit_entry'>%s</a>";
232     /* Dynamic action col, depending on snapshot icons */
233     $action_col_size = 122;
234     if($this->parent->snapshotEnabled()){
235       $action_col_size += 38;
236     }
238     /* Possilbe objectClass image combinations */  
239     $possibleAccounts = array(
240             "posixAccount"    => array("VAR"=>"posix"     ,"IMG"=>"posiximg"),
241             "gotoEnvironment" => array("VAR"=>"enviro"    ,"IMG"=>"eviroimg"),
242             "gosaMailAccount" => array("VAR"=>"maila"     ,"IMG"=>"mailimg"),
243             "goFaxAccount"    => array("VAR"=>"faxac"     ,"IMG"=>"faximg"),
244             "sambaSamAccount" => array("VAR"=>"samba"     ,"IMG"=>"sambaimg"),
245             "apple-user"      => array("VAR"=>"netatalk"  ,"IMG"=>"netatalkimg"));
247      /* Pictures for Extensions */
248     $usrimg   ="<input class='center' type='image' src='images/select_user.png' alt='"._("GOsa")."'
249                     name='user_edit_%KEY%-user' title='"._("Edit generic properties")."'>";
250     $posiximg = "<input class='center' type='image' src='images/penguin.png' alt='"._("Posix")."'
251                     name='user_edit_%KEY%-posixAccount' title='"._("Edit UNIX properties")."'>";
252     $eviroimg = "<input class='center' type='image' src='images/smallenv.png' alt='"._("Environment")."'
253                     name='user_edit_%KEY%-environment' title='"._("Edit environment properties")."'>";
254     $mailimg  = "<input class='center' type='image' src='images/mailto.png' alt='"._("Mail")."'
255                     name='user_edit_%KEY%-mailAccount' title='"._("Edit mail properties")."'>";
256     $fonimg   = "<input class='center' type='image' src='images/%image%' alt='"._("Phone")."'
257                     name='user_edit_%KEY%-phoneAccount' title='"._("Edit phone properties")."%title%'>";
258     $faximg   = "<input class='center' type='image' src='images/fax_small.png' alt='"._("Fax")."'
259                     name='user_edit_%KEY%-gofaxAccount' title='"._("Edit fax properies")."'>";
260     $sambaimg = "<input class='center' type='image' src='images/select_winstation.png' alt='"._("Samba")."'
261                     name='user_edit_%KEY%-sambaAccount' title='"._("Edit samba properties")."'>";
262     $netatalkimg = "<input class='center' type='image' src='images/select_netatalk.png' alt='"._("Netatalk")."'
263                     name='user_edit_%KEY%-netatalk' title='"._("Edit netatalk properties")."'>";
264     $tplcreateuserimg  = "<input type='image' class='center' src='images/lists/new.png' alt='"._("Create user from template")."'
265                     name='userfrom_tpl_%KEY%' title='"._("Create user with this template")."'>";
267     /********************
268       END :: Variable init
269      ********************/
271  
272     /********************
273       Append entries to divlist 
274      ********************/
275  
276     $ui = get_userinfo(); 
277   
278     // Test Every Entry and generate divlist Array
279     foreach($list as $key => $val){
280   
281       /* Create action icons */
282       $action= "";
284       /* Add copy & cut icons */     
285       $acl      = $ui->get_permissions($val['dn'],"users/user");
286       $acl_all  = $ui->has_complete_category_acls($val['dn'],"users");
287      
288       /* Add copy & cut functionality */
289       $action.= $this->parent->get_copypaste_action($val['dn'],"users","user");
291       /* Add deactivate status */
292       $lock_status = "";
294       if(isset($val['userPassword'][0]) && preg_match("/^\{[^\}]/",$val['userPassword'][0])){
295         if(preg_match("/^[^\}]*+\}!/",$val['userPassword'][0])){
296           $lock_status = "<input class='center' type='image' src='images/lists/locked.png'
297             alt='"._("inactive")."' name='toggle_lock_status_%KEY%'>";
298         }else{
299           $lock_status = "<input class='center' type='image' src='images/lists/unlocked.png'
300             alt='"._("active")."' name='toggle_lock_status_%KEY%'>";
301         }
302       }else{
303         $lock_status = "<img src='images/empty.png' alt=' ' class='center'>";
304       }
306       /* Generate edit icon */
307       $action.= "<input class='center' type='image' src='images/lists/edit.png' alt='"._("edit")."'
308         name='user_edit_%KEY%' title='".msgPool::editButton(_("user"))."'>";
310       /* Add deactivate status if we are allowed to */
311       if (preg_match("/w/",$ui->get_permissions($val['dn'],"users/password"))){
312         $action.= $lock_status;
313       }else{
314         $action.="<img src='images/empty.png' alt=' ' class='center'>";
315       }
317       /* Add Password change icon, if we are able to write users/password */
318       if(!in_array_ics("gosaUserTemplate",$val['objectClass']) && preg_match("/w/",$ui->get_permissions($val['dn'],"users/password"))) {
319         $action.= "<input class='center' type='image' src='images/list_password.png' alt='"._("password")."'
320           name='user_chgpw_%KEY%' title='"._("Change password")."'>";
321       }else{
322         $action.= "<img class='center' src='images/empty.png' alt='&nbsp;' 
323           title='"._("Not allowed")."'>";
324       }
326       /* Add snapshot functionality */
327       $action.= $this->parent->get_snapshot_action($val['dn'],$this->module);
329       /* Add remove icon, if we are allowed to remove the current user */
330       if(preg_match("/d/",$acl)) {
331         $action.= "<input class='center' type='image' src='images/lists/trash.png' alt='"._("delete")."'
332           name='user_del_%KEY%' title='"._("Delete user")."'>";
333       }else{
334         $action.= "<img class='center' src='images/empty.png' alt='&nbsp;'  
335           title='"._("Not allowed")."'>";
336       }
338       /* Create phonaccopunt informationm, if conencted && is phoneAccount */ 
339       if((in_array("goFonAccount"    ,$val['objectClass']))){
341         /* Set defaults */
342         $fonac = preg_replace("/%image%/", "select_phone.png", $fonimg);
343         $fonac = preg_replace("/%KEY%/", "$key", $fonac);
344         $fonac = preg_replace("/%title%/", "", $fonac);
346       }else{
347         $fonac=$empty;
348       }
350       /* Set images for different types of objectClasses */
351       foreach($possibleAccounts as $objectClass => $Settigns){ 
352         if(in_array($objectClass ,$val['objectClass'])){
353           $$Settigns['VAR'] = preg_replace("/%KEY%/", "$key", $$Settigns['IMG']);
354         }else{
355           $$Settigns['VAR'] = $empty;
356         }
357       }
359       /* Create userimg */
360       if(in_array("gosaUserTemplate",$val['objectClass'])){
361         $tpl                          = preg_replace("/%KEY%/", "$key", $tplimg);
362         $s_img_create_from_template   = preg_replace("/%KEY%/", "$key", $tplcreateuserimg);
363         $num_templates ++;
364       }else{
365         $s_img_create_from_template   = "";
366         $tpl                          = $userimg;
367         $num_users ++;
368       }
370       /* Insert key into userimg */
371       $usrimg2 = preg_replace("/%KEY%/", "$key", $usrimg);
373       // Generate caption for rows
374       if (isset($val["sn"]) && isset($val["givenName"])){
375         $display= $val["sn"][0].", ".$val["givenName"][0]." [".$val["uid"][0]."]";
376       } else {
377         $display= "[".$val["uid"][0]."]";
378       }
380       /* Connect all images */
381       $UseImg = $usrimg2."&nbsp;".$posix."&nbsp;".$enviro."&nbsp;".$maila."&nbsp;".$fonac."&nbsp;".$faxac."&nbsp;".$samba."&nbsp;".$netatalk;
383       /* Cutted objects should be displayed in light grey */ 
384       if($this->parent->CopyPasteHandler){
385         foreach($this->parent->CopyPasteHandler->queue as $queue_key => $queue_data){
386           if($queue_data['dn'] == $val['dn']) {
387             $display = "<font color='#999999'>".$display."</font>";
388             break;
389           }
390         }
391       }
393       /* Create each field */
394       $field0 = array("string" => "<input type='checkbox' id='item_selected_".$key."' name='item_selected_".$key."'>" ,
395                       "attach" => "style='width:20px;'");
396       $field1 = array("string" => sprintf($tpl,$val['dn']), "attach" => "style='text-align:center;width:20px;'");
397       $field2 = array("string" => sprintf($editlink,$key,$display), "attach" => "style='' title='".preg_replace('/ /', '&nbsp;', @LDAP::fix($val['dn']))."'");
398       $field3 = array("string" => $UseImg, "attach" => "style='width:166px;'");
399       $field4 = array("string" => $s_img_create_from_template.preg_replace("/%KEY%/", "$key", $action),
400                       "attach" => "style='width:".$action_col_size."px;border-right:0px;    text-align:right;'");
401       /* Add to list */
402       $add = array($field0,$field1,$field2,$field3,$field4);
403       $this->AddElement($add);
405       // Template or User
406       if(in_array("gosaUserTemplate",$val['objectClass'])){
407         $tpls[strtolower( $val['sn']['0'].$val['uid']['0'])]=$add;
408       }else{
409         $users[strtolower( $val['sn']['0'].$val['uid']['0'])]=$add;
410       }
411     }
414     /* Create summary string for list footer */
415     $num_deps=0;
416     if(!$this->SubSearch){
417       $num_deps = count($this->Added_Departments);
418     }
419     $num_users = count($list);
421     $num_user_str = _("Number of listed users");
422     $num_dep_str = _("Number of listed departments");
424     $str = "<img class='center' src='images/select_user.png'
425               title='".$num_user_str."' alt='".$num_user_str."'>&nbsp;".$num_users."&nbsp;&nbsp;&nbsp;&nbsp;";
426     $str.= "<img class='center' src='images/lists/folder.png'
427               title='".$num_dep_str."' alt='".$num_dep_str."'>&nbsp;".$num_deps."&nbsp;&nbsp;&nbsp;&nbsp;";
429     $this->set_List_Bottom_Info($str);
430   }
432   function Save()
433   {
434     MultiSelectWindow :: Save();  
435   }
437   function save_object()
438   {
439     /* Save automatic created POSTs like regex, checkboxes */
440     MultiSelectWindow::save_object();   
441   }
443 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
444 ?>