plugins/admin/fai/class_faiHook.inc

   1 <?php
   2
   3 class faiHook 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");
   9
  10   /* attribute list for save action */
  11   var $ignore_account   = TRUE;
  12
  13   /* Attributes for this Object */
  14   var $attributes       = array("cn","description");
  15
  16   /* ObjectClasses for this Object*/
  17   var $objectclasses    = array("top","FAIclass","FAIhook");
  18
  19   /* Class name of the Ldap ObjectClass for the Sub Object */
  20   var $subClass         = "FAIhookEntry";
  21   var $subClasses       = array("top","FAIclass","FAIhookEntry");
  22
  23   /* Class name of the php class which allows us to edit a Sub Object */
  24   var $subClassName     = "faiHookEntry";
  25
  26   /* Attributes to initialise for each subObject */
  27   var $subAttributes    = array("cn","description","FAItask","FAIscript");
  28   var $sub64coded       = array("FAItask","FAIscript");
  29
  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
  36
  37   function faiHook ($config, $dn= NULL)
  38   {
  39     /* Load Attributes */
  40     plugin::plugin ($config, $dn);
  41
  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      */
  45     if($dn != "new"){
  46       $this->dn =$dn;
  47
  48       /* Read all leaf objects of this object (For FAIscript this would be FAIscriptEntry)
  49        */
  50       $ldap     = $this->config->get_ldap_link();
  51       $ldap->cd ($this->dn);
  52       $ldap->search("(&(objectClass=FAIclass)(objectClass=".$this->subClass."))",$this->subAttributes);
  53
  54       while($object = $ldap->fetch()){
  55         /* Set status for save management */
  56
  57         foreach($this->subAttributes as $attrs){
  58           if(!isset($object[$attrs][0])){
  59             $this->SubObjects[$object['cn'][0]][$attrs]="";
  60           }else{
  61             $this->SubObjects[$object['cn'][0]][$attrs]=$object[$attrs][0];
  62           }
  63         }
  64
  65         $this->SubObjects[$object['cn'][0]]['status']      = "edited";
  66         $this->SubObjects[$object['cn'][0]]['dn']          = $object['dn'];
  67
  68         foreach($this->sub64coded as $codeIt){
  69           $this->SubObjects[$object['cn'][0]][$codeIt]=base64_decode($this->SubObjects[$object['cn'][0]][$codeIt]);
  70         }
  71
  72       }
  73     }
  74   }
  75
  76   function execute()
  77   {
  78     /* Fill templating stuff */
  79     $smarty= get_smarty();
  80     $display= "";
  81
  82     /* Add new sub object */
  83     if(isset($_POST['AddSubObject'])){
  84       $this->dialog= new $this->subClassName($this->config,"new");
  85       $this->is_dialog=true;
  86     }
  87
  88     /* Edit selected Sub Object */
  89     if((isset($_POST['EditSubObject']))&&(isset($_POST['SubObject']))){
  90       $this->dialog= new $this->subClassName($this->config,$this->dn,$this->SubObjects[$_POST['SubObject']]);
  91       $this->is_dialog=true;
  92     }
  93
  94     /* Remove Sub object */
  95     if((isset($_POST['DelSubObject']))&&(isset($_POST['SubObject']))){
  96       if($this->SubObjects[$_POST['SubObject']]['status'] == "edited"){
  97         $this->SubObjects[$_POST['SubObject']]['status']= "delete";
  98       }else{
  99         unset($this->SubObjects[$_POST['SubObject']]);
 100       }
 101     }
 102
 103     /* Save Dialog */
 104     if(isset($_POST['SaveSubObject'])){
 105
 106       /* Perform post check*/
 107       $this->dialog->save_object();
 108
 109       /* Get messages */
 110       $msgs = $this->dialog->check();
 111
 112       /* print errors */
 113       if(count($msgs)>0){
 114         foreach($msgs as $msg){
 115           print_red($msg);
 116         }
 117       }else{
 118
 119         /* Get return object */
 120         $obj = $this->dialog->save();
 121         if(isset($obj['remove'])){
 122
 123           /* Depending on status, set new status */
 124           if($this->SubObjects[$obj['remove']['from']]['status']=="edited"){
 125             $this->SubObjects[$obj['remove']['from']]['status'] = "delete";
 126           }elseif($this->SubObjects[$obj['remove']['from']]['status']=="new"){
 127             unset($this->SubObjects[$obj['remove']['from']]);
 128           }
 129           $obj['status'] = "new";
 130           $this->SubObjects[$obj['remove']['to']] = $obj;
 131           unset($this->SubObjects[$obj['remove']['to']]['remove']);
 132         }else{
 133           $this->SubObjects[$obj['cn']]=$obj;
 134         }
 135         $this->is_dialog=false;
 136         unset($this->dialog);
 137         $this->dialog=NULL;
 138       }
 139     }
 140
 141     /* Cancel Dialog */
 142     if(isset($_POST['CancelSubObject'])){
 143       $this->is_dialog=false;
 144       unset($this->dialog);
 145       $this->dialog=NULL;
 146     }
 147
 148     /* Print dialog if $this->dialog is set */
 149     if($this->dialog){
 150       $this->dialog->save_object();
 151       $display = $this->dialog->execute();
 152       return($display);
 153     }
 154
 155     $smarty->assign("SubObjects",$this->getList());
 156     $smarty->assign("SubObjectKeys",array_flip($this->getList()));
 157     /* Assign variables */
 158     foreach($this->attributes as $attrs){
 159       $smarty->assign($attrs,$this->$attrs);
 160     }
 161
 162     $display.= $smarty->fetch(get_template_path('faiHook.tpl', TRUE));
 163     return($display);
 164   }
 165
 166   /* Generate listbox friendly SubObject list
 167   */
 168   function getList(){
 169     $a_return=array();
 170     foreach($this->SubObjects as $obj){
 171       if($obj['status'] != "delete"){
 172         $a_return[$obj['cn']]= $obj['cn']." [".$obj['description']."]";
 173       }
 174     }
 175     return($a_return);
 176   }
 177
 178   /* Delete me, and all my subtrees
 179    */
 180   function remove_from_parent()
 181   {
 182     $ldap = $this->config->get_ldap_link();
 183     $ldap->cd ($this->dn);
 184     $ldap->rmdir_recursive($this->dn);
 185     $this->handle_post_events("remove");
 186   }
 187
 188
 189   /* Save data to object
 190    */
 191   function save_object()
 192   {
 193     plugin::save_object();
 194     foreach($this->attributes as $attrs){
 195       if(isset($_POST[$attrs])){
 196         $this->$attrs = $_POST[$attrs];
 197       }
 198     }
 199   }
 200
 201
 202   /* Check supplied data */
 203   function check()
 204   {
 205     $message= array();
 206     $str = utf8_encode("üöä");
 207     if((empty($this->description))||(preg_match("/[^a-z0-9".$str."\-.,;:_\? ]/i",$this->description))){
 208       $message[]=_("Please enter a valid description.");
 209     }
 210     return ($message);
 211   }
 212
 213
 214   /* Save to LDAP */
 215   function save()
 216   {
 217     plugin::save();
 218
 219     $ldap = $this->config->get_ldap_link();
 220
 221     $ldap->cat($this->dn);
 222     if($ldap->count()!=0){
 223       /* Write FAIscript to ldap*/
 224       $ldap->cd($this->dn);
 225       $ldap->modify($this->attrs);
 226     }else{
 227       /* Write FAIscript to ldap*/
 228       $ldap->cd($this->config->current['BASE']);
 229       $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $this->dn));
 230       $ldap->cd($this->dn);
 231       $ldap->add($this->attrs);
 232     }
 233     show_ldap_error($ldap->get_error());
 234
 235     /* Prepare FAIscriptEntry to write it to ldap
 236      * First sort array.
 237      *  Because we must delete old entries first.
 238      * After deletion, we perform add and modify
 239      */
 240     $Objects = array();
 241     foreach($this->SubObjects as $name => $obj){
 242       if($obj['status'] == "delete"){
 243         $Objects[$name] = $obj;
 244       }
 245     }
 246     foreach($this->SubObjects as $name => $obj){
 247       if($obj['status'] != "delete"){
 248         $Objects[$name] = $obj;
 249       }
 250     }
 251
 252     foreach($Objects as $name => $obj){
 253
 254       foreach($this->sub64coded as $codeIt){
 255         $obj[$codeIt]=base64_encode($obj[$codeIt]);
 256       }
 257
 258       $tmp = array();
 259       foreach($this->subAttributes as $attrs){
 260         if(empty($obj[$attrs])){
 261           $obj[$attrs] = array();
 262         }
 263         $tmp[$attrs] = $obj[$attrs];
 264       }
 265
 266       $tmp['objectClass'] = $this->subClasses;
 267
 268       $sub_dn = "cn=".$obj['cn'].",".$this->dn;
 269
 270       if($obj['status'] == "delete"){
 271         $ldap->cd($sub_dn);
 272         $ldap->rmdir_recursive($sub_dn);
 273         $this->handle_post_events("remove");
 274       }elseif($obj['status'] == "edited"){
 275         $ldap->cd($sub_dn);
 276         $ldap->modify($tmp);
 277         $this->handle_post_events("modify");
 278       }elseif($obj['status']=="new"){
 279         $ldap->cd($this->config->current['BASE']);
 280         $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $sub_dn));
 281         $ldap->cd($sub_dn);
 282         $ldap->add($tmp);
 283         $this->handle_post_events("add");
 284       }
 285       show_ldap_error($ldap->get_error());
 286     }
 287   }
 288 }
 289
 290 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 291 ?>