Code

Fixed search syntax to include FAIpackagelist
[gosa.git] / plugins / admin / fai / class_faiTemplate.inc
1 <?php
3 class faiTemplate extends plugin
4 {
5   /* CLI vars */
6   var $cli_summary      = "Manage server basic objects";
7   var $cli_description  = "Some longer text\nfor help";
8   var $cli_parameters   = array("eins" => "Eins ist toll", "zwei" => "Zwei ist noch besser");
10   /* attribute list for save action */
11   var $ignore_account   = TRUE;
13   /* Attributes for this Object */
14   var $attributes       = array("cn","description");
16   /* ObjectClasses for this Object*/
17   var $objectclasses    = array("top","FAIclass","FAItemplate");
19   /* Class name of the Ldap ObjectClass for the Sub Object */
20   var $subClass         = "FAItemplateEntry";
21   var $subClasses       = array("top","FAIclass","FAItemplateEntry");
23   /* Class name of the php class which allows us to edit a Sub Object */
24   var $subClassName     = "faiTemplateEntry";      
26   /* Attributes to initialise for each subObject */
27   var $subAttributes    = array("cn","description","FAItemplateFile","FAItemplatePath","FAIowner","FAImode"); 
28   var $sub64coded       = array();
30   /* Specific attributes */
31   var $cn               = "";       // The class name for this object
32   var $description      = "";       // The description for this set of partitions
33   var $is_dialog        = false;    // specifies which buttons will be shown to save or abort
34   var $dialog           = NULL;     // a dialog, e.g. new disk dialog
35   var $SubObjects       = array();  // All leafobjects of this object
37   function faiTemplate ($config, $dn= NULL)
38   {
39     /* Load Attributes */
40     plugin::plugin ($config, $dn);
42     /* If "dn==new" we try to create a new entry
43      * Else we must read all objects from ldap which belong to this entry.
44      * First read SubObjects from ldap ... and then the partition definitions for the SubObjects.
45      */
46     if($dn != "new"){
47       $this->dn =$dn;
49       /* Read all leaf objects of this object (For FAIscript this would be FAIscriptEntry)
50        */
51       $ldap     = $this->config->get_ldap_link();
52       $ldap->cd ($this->dn);
53       $ldap->search("(&(objectClass=FAIclass)(objectClass=".$this->subClass."))",$this->subAttributes);
55       while($object = $ldap->fetch()){
56         /* Set status for save management */
57   
58         foreach($this->subAttributes as $attrs){
59           if(!isset($object[$attrs][0])){
60             $this->SubObjects[$object['cn'][0]][$attrs]="";
61           }else{
62             $this->SubObjects[$object['cn'][0]][$attrs]=$object[$attrs][0];
63           }
64         }
66         foreach($this->sub64coded as $codeIt){
67           $this->SubObjects[$object['cn'][0]][$codeIt]= base64_decode($this->SubObjects[$object['cn'][0]][$codeIt]);
68         }       
70         $this->SubObjects[$object['cn'][0]]['FAItemplateFile']= $this->readBinary("FAItemplateFile",$object['dn']);
71        
72         $this->SubObjects[$object['cn'][0]]['status']= "edited";
73         $this->SubObjects[$object['cn'][0]]['dn']= $object['dn'];
74       }
75       ksort($this->SubObjects);
76     }
77   }
79   function execute()
80   {
81         /* Call parent execute */
82         plugin::execute();
84     /* Fill templating stuff */
85     $smarty= get_smarty();
86     $display= "";
88     /* Add new sub object */
89     if(isset($_POST['AddSubObject'])){
90       $this->dialog= new $this->subClassName($this->config,"new");
91       $this->is_dialog=true;
92     }
94     if($this->dn != "new"){
95       $_SESSION['objectinfo']= $this->dn;
96     }
99     /* Edit selected Sub Object */
100     if((isset($_POST['EditSubObject']))&&(isset($_POST['SubObject']))){
101       $this->dialog= new $this->subClassName($this->config,$this->dn,$this->SubObjects[$_POST['SubObject']]);
102       $_SESSION['objectinfo'] = $this->SubObjects[$_POST['SubObject']]['dn'];
103       $this->is_dialog=true;
104     }
105     
106     /* Remove Sub object */
107     if((isset($_POST['DelSubObject']))&&(isset($_POST['SubObject']))){
108       if($this->SubObjects[$_POST['SubObject']]['status'] == "edited"){
109         $this->SubObjects[$_POST['SubObject']]['status']= "delete";
110       }else{
111         unset($this->SubObjects[$_POST['SubObject']]);
112       }
113     }
115     /* Save Dialog */
116     if(isset($_POST['SaveSubObject'])){
117       $this->dialog->save_object();
118       $msgs = $this->dialog->check();
119       if(count($msgs)>0){
120         foreach($msgs as $msg){
121           print_red($msg);
122         }
123       }else{
124         $obj = $this->dialog->save();
125         if(isset($obj['remove'])){
126           if($this->SubObjects[$obj['remove']['from']]['status']=="edited"){
127             $this->SubObjects[$obj['remove']['from']]['status'] = "delete";
128           }elseif($this->SubObjects[$obj['remove']['from']]['status']=="new"){
129             unset($this->SubObjects[$obj['remove']['from']]);
130           }
131           $obj['status'] = "new";
132           $this->SubObjects[$obj['remove']['to']] = $obj;
133           unset($this->SubObjects[$obj['remove']['to']]['remove']);
134         }else{
135           $this->SubObjects[$obj['cn']]=$obj;
136         }
137         $this->is_dialog=false;
138         unset($this->dialog);
139         $this->dialog=NULL;
140         ksort($this->SubObjects);
141       }
142     }
144     /* Cancel Dialog */
145     if(isset($_POST['CancelSubObject'])){
146       $this->is_dialog=false; 
147       unset($this->dialog);
148       $this->dialog=NULL;
149     }
151     /* Print dialog if $this->dialog is set */
152     if($this->dialog){
153       $this->dialog->save_object();
154       $display = $this->dialog->execute();
155       return($display);
156     }
158     $smarty->assign("SubObjects",$this->getList());
159     $smarty->assign("SubObjectKeys",array_flip($this->getList()));
161      /* Magic quotes GPC, escapes every ' " \, to solve some security risks
162      * If we post the escaped strings they will be escaped again
163      */
164     foreach($this->attributes as $attrs){
165       if(get_magic_quotes_gpc()){
166         $smarty->assign($attrs,stripslashes($this->$attrs));
167       }else{
168         $smarty->assign($attrs,($this->$attrs));
169       }
170     }
173     $display.= $smarty->fetch(get_template_path('faiTemplate.tpl', TRUE));
174     return($display);
175   }
177   /* Generate listbox friendly SubObject list
178   */
179   function getList(){
180     $a_return=array();
181     foreach($this->SubObjects as $obj){
182       if($obj['status'] != "delete"){
183         if((isset($obj['description']))&&(!empty($obj['description']))){
184           $a_return[$obj['cn']]= $obj['cn']." [".$obj['description']."]";
185         }else{
186           $a_return[$obj['cn']]= $obj['cn'];
187         }
188       }
189     }
190     return($a_return);
191   }
193   /* Delete me, and all my subtrees
194    */
195   function remove_from_parent()
196   {
197     $ldap = $this->config->get_ldap_link();
198     $ldap->cd ($this->dn);
199     $ldap->rmdir_recursive($this->dn);
200     $this->handle_post_events("remove");    
201   }
204   /* Save data to object 
205    */
206   function save_object()
207   {
208     if(isset($_POST['FAItemplate_posted'])){
209       plugin::save_object();
210       foreach($this->attributes as $attrs){
211         if(isset($_POST[$attrs])){
212           $this->$attrs = $_POST[$attrs];
213         } 
214       }
215     }
216   }
219   /* Check supplied data */
220   function check()
221   {
222     $message= array();
223     return ($message);
224   }
227   /* Save to LDAP */
228   function save()
229   {
230     plugin::save();
231  
232     $ldap = $this->config->get_ldap_link();
233   
234     $ldap->cat($this->dn);
235     if($ldap->count()!=0){
236       /* Write FAIscript to ldap*/
237       $ldap->cd($this->dn);
238       $ldap->modify($this->attrs);
239     }else{
240       /* Write FAIscript to ldap*/
241       $ldap->cd($this->config->current['BASE']);
242       $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $this->dn));
243       $ldap->cd($this->dn);
244       $ldap->add($this->attrs);
245     }
246     show_ldap_error($ldap->get_error());
247  
248     /* Prepare FAIscriptEntry to write it to ldap
249      * First sort array.
250      *  Because we must delete old entries first.
251      * After deletion, we perform add and modify 
252      */
253     $Objects = array();
254     foreach($this->SubObjects as $name => $obj){
255       if($obj['status'] == "delete"){
256         $Objects[$name] = $obj; 
257       }
258     }
259     foreach($this->SubObjects as $name => $obj){
260       if($obj['status'] != "delete"){
261         $Objects[$name] = $obj; 
262       }
263     }
265     foreach($Objects as $name => $obj){
267       foreach($this->sub64coded as $codeIt){
268         $obj[$codeIt]=base64_encode($obj[$codeIt]);
269       }
270       $tmp = array();
271       foreach($this->subAttributes as $attrs){
272         if(empty($obj[$attrs])){
273           $obj[$attrs] = array();
274         }
275         $tmp[$attrs] = $obj[$attrs];
276       }    
277         
278       $tmp['objectClass'] = $this->subClasses;
280       $sub_dn = "cn=".$obj['cn'].",".$this->dn;
282       if($obj['status']=="new"){
283         $ldap->cat($sub_dn);
284         if($ldap->count()){
285           $obj['status']="modify";
286         }
287       }
289       if($obj['status'] == "delete"){
290         $ldap->cd($sub_dn);
291         $ldap->rmdir_recursive($sub_dn);
292         $this->handle_post_events("remove");
293       }elseif($obj['status'] == "edited"){
294         $ldap->cd($sub_dn);
295         $ldap->modify($tmp);
296         $this->handle_post_events("modify");
297       }elseif($obj['status']=="new"){
299         if($tmp['description']==array()){
300           unset($tmp['description']);
301         }
302         $ldap->cd($this->config->current['BASE']);
303         $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $sub_dn));
304         $ldap->cd($sub_dn);
305         $ldap->add($tmp); 
306         $this->handle_post_events("add");
307       }
308       show_ldap_error($ldap->get_error()); 
309     }
310   }
312   function readBinary($attr,$dn){
313     $Data  ="";
314     $ds= ldap_connect($this->config->current['SERVER']);
315     ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
316     if (function_exists("ldap_set_rebind_proc") && isset($this->config->current['RECURSIVE']) && $this->config->current['RECURSIVE'] == "true") {
317       ldap_set_option($this->cid, LDAP_OPT_REFERRALS, 1);
318       ldap_set_rebind_proc($ds, array(&$this, "rebind"));
319     }
321     if(isset($this->config->current['TLS']) &&  $this->config->current['TLS'] == "true"){
322       ldap_start_tls($ds);
323     }
325     $r  = ldap_bind($ds);
326     $sr = @ldap_read($ds, $dn, $attr."=*", array($attr));
328     if ($sr) {
329       $ei=ldap_first_entry($ds, $sr);
330       if ($ei) {
331         if ($info = ldap_get_values_len($ds, $ei, $attr)){
332           $Data= $info[0];
333         }
334       }
335     }
337     /* close conncetion */
338     ldap_unbind($ds);
339     return($Data);
340   }
343 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
344 ?>