gosa-plugins/opsi/admin/opsi/class_opsi.inc

   1 <?php
   2 /*
   3    This code is part of GOsa (https://gosa.gonicus.de)
   4    Copyright (C) 2008  Fabian Hickert
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation, either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20
  21 /********
  22
  23   public function __construct($config)
  24   public function enabled()
  25   function get_hosts_for_system_management()
  26   private function xml_to_array($xml,$alternative_method = FALSE)
  27   public function send_action($type,$hostId,$mac)
  28   public function list_clients( $hostId = "")
  29   public function add_client($hostId,$macaddress,$notes,$description)
  30   public function modify_client($hostId,$mac,$notes,$description)
  31   public function get_netboot_products($host = "")
  32   public function get_local_products($host = "")
  33   public function get_product_properties($productId,$hostId = "")
  34   public function set_product_properties($productId,$cfg,$hostId = "")
  35   public function add_product_to_client($productId,$hostId)
  36   public function del_product_from_client($productId,$hostId)
  37   public function get_client_hardware($hostId)
  38   public function get_client_software($hostId)
  39   public function del_client($hostId)
  40   public function job_opsi_install_client($hostId,$mac)
  41
  42  ********/
  43
  44
  45 /*! \brief  This is the opsi base class, it handles
  46   .          gosa daemon requests and prepares data for opsi plugins.
  47  */
  48 class opsi extends gosaSupportDaemon
  49 {
  50   private $config = NULL;
  51   protected $use_alternative_xml_parse_method = TRUE;
  52   protected $target = "";
  53
  54   /*! \brief            Create opsi object.
  55     @param
  56     @return
  57    */
  58   public function __construct($config)
  59   {
  60     $this->config = $config;
  61     gosaSupportDaemon::__construct($config);
  62
  63     /* Detect the target opsi host
  64      */
  65     $tmp= $this->config->search("faiManagement", "CLASS",array('menu','tabs'));
  66     if(!empty($tmp) && class_available("faiManagement")){
  67       $opsi_hosts = $this->get_hosts_with_module("opsi_com");
  68
  69       /* Just use the first result of the opsi hosts
  70        */
  71       if(count($opsi_hosts) == 1 && isset($opsi_hosts[0])){
  72         $this->target = $opsi_hosts[0];
  73       }elseif(count($opsi_hosts) > 1){
  74         $this->target = $opsi_hosts[0];
  75         msg_dialog::display(_("Opsi"),sprintf(_("More than one Opsi server were found, using the first result '%s'."),$this->target));
  76       }
  77     }
  78   }
  79
  80
  81   public function enabled()
  82   {
  83     $tmp= $this->config->search("faiManagement", "CLASS",array('menu','tabs'));
  84     if(!empty($tmp) && class_available("faiManagement") && !empty($this->target)){
  85       return(TRUE);
  86     }
  87     return(FALSE);
  88   }
  89
  90
  91   /******************
  92     Opsi handling
  93    ******************/
  94
  95   function get_hosts_for_system_management()
  96   {
  97     $res = $this->list_clients();
  98     $data = array();
  99     $ui = get_userinfo();
 100     foreach($res as $entry){
 101       if(!isset($entry['MAC'][0]['VALUE'])) $entry['MAC'][0]['VALUE'] = "";
 102       $obj = array(
 103         "dn"          => "opsi:=".$entry['NAME'][0]['VALUE'].",".get_ou("sambaMachineAccountRDN").$this->config->current['BASE'],
 104         "objectClass" => array("gosa_opsi_client"),
 105         "cn"          => array(0 => $entry['NAME'][0]['VALUE']),
 106         "macAddress"  => array(0 => $entry['MAC'][0]['VALUE']),
 107         "opsi_notes"  => array(0 => $entry['NOTES'][0]['VALUE']));
 108
 109       /* Check permissions */
 110       $opsi_acl = $ui->get_permissions($obj['dn'],"opsi/opsiGeneric");
 111       if(preg_match("/r/",$opsi_acl)){
 112         if(!empty($entry['DESCRIPTION'][0]['VALUE'])){
 113           $obj["description"]= array();
 114           $obj["description"][0]= $entry['DESCRIPTION'][0]['VALUE'];
 115         }
 116         $data[] = $obj;
 117       }
 118     }
 119
 120     return($data);
 121   }
 122
 123
 124   /*! \brief  Maps all xml to array conversion to an alternative method
 125                 then used in the parent class 'gosaSupportDaemon'.
 126               The alternative method is able to handle more complex data.
 127    */
 128   private function xml_to_array($xml,$alternative_method = FALSE)
 129   {
 130     return(gosaSupportDaemon::xml_to_array($xml,TRUE));
 131   }
 132
 133
 134   /*! \brief  Trigger an event like wake or install for a specific hostId.
 135    */
 136   public function send_action($type,$hostId,$mac)
 137   {
 138     switch($type){
 139       case 'install'  :  $this->job_opsi_install_client($hostId,$mac); break;
 140       default         :  trigger_error('Unknown type '.$type.'.');
 141     }
 142   }
 143
 144
 145   public function job_opsi_activate_client($id,$mac)
 146   {
 147     $events = DaemonEvent::get_event_types(SYSTEM_EVENT | HIDDEN_EVENT);
 148     $o_queue = new gosaSupportDaemon();
 149     if(isset($events['TRIGGERED']['DaemonEvent_activate'])){
 150       $evt = $events['TRIGGERED']['DaemonEvent_activate'];
 151       $tmp = new $evt['CLASS_NAME']($this->config);
 152       $tmp->set_type(TRIGGERED_EVENT);
 153       $tmp->add_targets(array($mac));
 154       if(!$o_queue->append($tmp)){
 155         msg_dialog::display(_("Service infrastructure"),msgPool::siError($o_queue->get_error()),ERROR_DIALOG);
 156       }
 157     }
 158   }
 159
 160
 161
 162   /******************
 163     SI Communication functions
 164    ******************/
 165
 166
 167
 168   /*! \brief            Returns a list of all opsi clients.
 169     @param
 170     @return
 171    */
 172   public function list_clients( $hostId = "")
 173   {
 174     $data   = array();
 175     $res    = $this->send_data("gosa_opsi_list_clients",$this->target,$data,TRUE);
 176     $items  = array();
 177     if(isset($res['XML'][0]['ITEM'])){
 178       $items = $res['XML'][0]['ITEM'];
 179     }
 180     return($items);
 181   }
 182
 183
 184   /*! \brief            Adds a new opsi client.
 185     @param
 186     @return
 187    */
 188   public function add_client($hostId,$macaddress,$notes,$description)
 189   {
 190     $data = array("hostId" => $hostId,"macaddress" => $macaddress);
 191
 192     if(empty($hostId)){
 193       trigger_error("No valid host id given, check parameter 1.");
 194       return;
 195     }
 196
 197     /* Add optional attributes */
 198     foreach(array("notes","description") as $attr) {
 199       if(!empty($$attr)){
 200         $data[$attr] = $$attr;
 201       }
 202     }
 203
 204     /* Query SI server */
 205     $res    = $this->send_data("gosa_opsi_add_client",$this->target,$data,TRUE);
 206   }
 207
 208
 209   /*! \brief            Modify an opsi client.
 210     @param
 211     @return
 212    */
 213   public function modify_client($hostId,$mac,$notes,$description)
 214   {
 215     $data = array("hostId" => $hostId,"mac" => $mac);
 216
 217     if(empty($hostId)){
 218       trigger_error("No valid host id given, check parameter 1.");
 219       return;
 220     }
 221
 222     /* Add optional attributes */
 223     foreach(array("notes","description") as $attr) {
 224       $data[$attr] = $$attr;
 225     }
 226
 227     /* Query SI server */
 228     $res = $this->send_data("gosa_opsi_modify_client",$this->target,$data,TRUE);
 229   }
 230
 231
 232
 233   /*! \brief            Returns a list of netboot products.
 234     @param
 235     @return
 236    */
 237   public function get_netboot_products($host = "")
 238   {
 239     /* Append host attribute to query data
 240      */
 241     $data = array();
 242     if(!empty($host)){
 243       $data['hostId'] = trim($host);
 244     }
 245
 246     $res    = $this->send_data("gosa_opsi_get_netboot_products",$this->target,$data,TRUE);
 247     $items = array();
 248     if(isset($res['XML'][0]['ITEM'])){
 249       foreach($res['XML'][0]['ITEM'] as $entry){
 250         $e = array("DESC" => $entry['DESCRIPTION'][0]['VALUE'],
 251                    "NAME" => $entry['PRODUCTID'][0]['VALUE']);
 252         $items[$entry['PRODUCTID'][0]['VALUE']] = $e;
 253       }
 254     }
 255     return($items);
 256   }
 257
 258
 259   /*! \brief            Returns a list of all local products.
 260     @param
 261     @return
 262    */
 263   public function get_local_products($host = "")
 264   {
 265     /* Append host attribute to query data
 266      */
 267     $data = array();
 268     if(!empty($host)){
 269       $data['hostId'] = trim($host);
 270     }
 271
 272     $res    = $this->send_data("gosa_opsi_get_local_products",$this->target,$data,TRUE);
 273     $items = array();
 274     if(isset($res['XML'][0]['ITEM'])){
 275       foreach($res['XML'][0]['ITEM'] as $entry){
 276         $e = array("DESC" => $entry['DESCRIPTION'][0]['VALUE'],
 277                    "NAME" => $entry['PRODUCTID'][0]['VALUE']);
 278         $items[$entry['PRODUCTID'][0]['VALUE']] = $e;
 279       }
 280     }
 281     return($items);
 282   }
 283
 284
 285   /*! \brief            Returns a list of netboot products.
 286     @param
 287     @return
 288    */
 289   public function get_full_product_host_information($host = "")
 290   {
 291     /* Append host attribute to query data
 292      */
 293     $data = array();
 294     if(!empty($host)){
 295       $data['hostId'] = trim($host);
 296     }
 297
 298     $res    = $this->send_data("gosa_opsi_get_full_product_host_information",$this->target,$data,TRUE);
 299     $items = array();
 300
 301     $attrs = array("PRIORITY","ONCESCRIPT","LICENSEREQUIRED","PACKAGEVERSION","PRODUCTVERSION",
 302         "ADVICE","SETUPSCRIPT","WINDOWSSOFTWAREIDS","PXECONFIGTEMPLATE","NAME","CREATIONTIMESTAMP", "TYPE",
 303         "ALWAYSSCRIPT","PRODUCTID","DESCRIPTION","UNINSTALLSCRIPT","UPDATESCRIPT","PRODUCTCLASSNAMES");
 304
 305     if(isset($res['XML'][0]['ITEM'])){
 306       foreach($res['XML'][0]['ITEM'] as $entry){
 307         $e = array();
 308         foreach($attrs as $attr){
 309           if(isset($entry[$attr])){
 310             foreach($entry[$attr] as $key => $value){
 311               if(isset($value['VALUE'])){
 312                 $e['data'][$attr] = $value['VALUE'];
 313               }elseif($value['ELEMENT']){
 314                 foreach($value['ELEMENT'] as $element){
 315                   $e['data'][$attr][] = $element['VALUE'];
 316                 }
 317               }
 318             }
 319           }
 320         }
 321
 322         $e["configurable"] = FALSE;
 323         if(isset($entry['PROPERTIES']) && count($entry['PROPERTIES'])){
 324           $e["configurable"] = TRUE;
 325           $p_data = array();
 326
 327           foreach($entry['PROPERTIES'][0] as $p_name => $p_values){
 328             if(empty($p_values)) continue;
 329             $p_data[$p_name]= array();
 330             foreach(array('CURRENT','DEFAULT','DESCRIPTION') as $p_tmp){
 331               if(isset($p_values[0][$p_tmp])){
 332                 if(isset($p_values[0][$p_tmp][0]['VALUE'])){
 333                   $p_data[$p_name][$p_tmp] = $p_values[0][$p_tmp][0]['VALUE'];
 334                 }
 335               }
 336             }
 337
 338             if(isset($p_values[0]['VALUES'][0]['ELEMENT'])){
 339               foreach($p_values[0]['VALUES'][0]['ELEMENT'] as $val){
 340                 $p_data[$p_name]['VALUE'][] = $val['VALUE'];
 341               }
 342               $p_data[$p_name]['VALUE_CNT'] = count($p_data[$p_name]['VALUE']);
 343             }
 344           }
 345
 346           $e["data"]['PROPERTIES'] = $p_data;
 347         }
 348
 349
 350         $e["installed"] = FALSE;
 351         if(isset($entry['ACTIONREQUEST'])){
 352           $e["installed"] = TRUE;
 353         }
 354
 355         $e["requires_licence"] = FALSE;
 356         if(isset($e['data']['LICENSEREQUIRED']) && preg_match("/true/i",$e['data']['LICENSEREQUIRED'])){
 357           $e["requires_licence"] = TRUE;
 358         }
 359         $items[$entry['PRODUCTID'][0]['VALUE']] = $e;
 360       }
 361     }
 362 print_a($items);
 363     return($items);
 364   }
 365
 366
 367   /*! \brief            Returns a list of all product properties. \
 368     .           Additionally you can specify the host parameter to \
 369     .           get host specific product properties
 370     @param
 371     @return
 372    */
 373   public function get_product_properties($productId,$hostId = "")
 374   {
 375     $data = array("productId" => $productId);
 376
 377     /* Append host attribute to query data
 378      */
 379     if(!empty($hostId)){
 380       $data['hostId'] = trim($hostId);
 381     }
 382
 383     /* Check parameter */
 384     if(empty($productId)){
 385       trigger_error("No valid product id given, check parameter 1.");
 386       return(array());
 387     }
 388
 389     /* Query SI server */
 390     $res    = $this->send_data("gosa_opsi_get_product_properties",$this->target,$data,TRUE);
 391     $items  = array();
 392     if(isset($res['XML'][0]['ITEM'])){
 393       foreach($res['XML'][0]['ITEM'] as $entry){
 394         foreach($entry as $name => $val){
 395
 396           foreach(array("DESCRIPTION","DEFAULT") as $attr){
 397             $items[$name][$attr] = "";
 398             if(isset($val[0][$attr])){
 399               $items[$name][$attr] = $val[0][$attr][0]['VALUE'];
 400             }
 401           }
 402           $items[$name]['VALUE'] = array();
 403           if(isset($val['0']['VALUE'])){
 404             foreach($val['0']['VALUE'] as $value){
 405               $items[$name]['VALUE'][] = $value['VALUE'];
 406             }
 407           }
 408           $items[$name]['VALUE_CNT'] = count($items[$name]['VALUE']);
 409         }
 410       }
 411     }
 412     return($items);
 413   }
 414
 415
 416   /*! \brief            Set product properties, globally or per host.
 417     @param
 418     @return
 419    */
 420   public function set_product_properties($productId,$cfg,$hostId = "")
 421   {
 422     $data = array("productId" => $productId);
 423
 424     /* Append host attribute to query data
 425      */
 426     if(!empty($hostId)){
 427       $data['hostId'] = trim($hostId);
 428     }
 429
 430     /* Check parameter */
 431     if(empty($productId)){
 432       trigger_error("No valid product id given, check parameter 1.");
 433       return(array());
 434     }
 435
 436     if(!count($cfg)) return;
 437
 438     /* Add properties */
 439     $data['item'] = array();
 440     foreach($cfg as $name => $value){
 441       $data['item'][] = "<name>".$name."</name><value>".$value['DEFAULT']."</value>";
 442     }
 443
 444     /* Query SI server */
 445     $res    = $this->send_data("gosa_opsi_set_product_properties",$this->target,$data,TRUE);
 446   }
 447
 448
 449   /*! \brief            Adds a given product to a client.
 450     @param
 451     @return
 452    */
 453   public function add_product_to_client($productId,$hostId)
 454   {
 455     $data = array("productId" => $productId,"hostId" => $hostId);
 456
 457     /* Check parameter */
 458     if(empty($productId)){
 459       trigger_error("No valid product id given, check parameter 1.");
 460       return;
 461     }
 462     if(empty($hostId)){
 463       trigger_error("No valid host id given, check parameter 2.");
 464       return;
 465     }
 466
 467     /* Query SI server */
 468     $res    = $this->send_data("gosa_opsi_add_product_to_client",$this->target,$data,TRUE);
 469   }
 470
 471
 472   /*! \brief      Removes a given product from a client.
 473     @param
 474     @return
 475    */
 476   public function del_product_from_client($productId,$hostId)
 477   {
 478     $data = array("productId" => $productId,"hostId" => $hostId);
 479
 480     /* Check parameter */
 481     if(empty($productId)){
 482       trigger_error("No valid product id given, check parameter 1.");
 483       return;
 484     }
 485     if(empty($hostId)){
 486       trigger_error("No valid host id given, check parameter 2.");
 487       return;
 488     }
 489
 490     /* Query SI server */
 491     $res    = $this->send_data("gosa_opsi_del_product_from_client",$this->target,$data,TRUE);
 492   }
 493
 494
 495   /*! \brief            Returns the clients hardware setup.
 496     @param
 497     @return
 498    */
 499   public function get_client_hardware($hostId)
 500   {
 501     $data = array("hostId" => $hostId);
 502
 503     /* Check parameter */
 504     if(empty($hostId)){
 505       trigger_error("No valid host id given, check parameter 1.");
 506       return;
 507     }
 508
 509     /* Query SI server */
 510     $res    = $this->send_data("gosa_opsi_get_client_hardware",$this->target,$data,TRUE);
 511     if(isset($res['XML'][0]['ITEM'])){
 512       return($res['XML'][0]['ITEM']);
 513     }
 514     return(array());
 515   }
 516
 517
 518   /*! \brief            Returns the clients software setup.
 519     @param
 520     @return
 521    */
 522   public function get_client_software($hostId)
 523   {
 524     $data = array("hostId" => $hostId);
 525
 526     /* Check parameter */
 527     if(empty($hostId)){
 528       trigger_error("No valid host id given, check parameter 1.");
 529       return;
 530     }
 531
 532     /* Query SI server */
 533     $res    = $this->send_data("gosa_opsi_get_client_software",$this->target,$data,TRUE);
 534     if(isset($res['XML'][0]['ITEM'])){
 535       return($res['XML'][0]['ITEM']);
 536     }
 537     return(array());
 538   }
 539
 540
 541
 542   /*! \brief            Deletes the given opsi client.
 543     @param
 544     @return
 545    */
 546   public function del_client($hostId)
 547   {
 548     $data = array("hostId" => $hostId);
 549
 550     /* Check parameter */
 551     if(empty($hostId)){
 552       trigger_error("No valid host id given, check parameter 1.");
 553       return;
 554     }
 555
 556     /* Query SI server */
 557     $res    = $this->send_data("gosa_opsi_del_client",$this->target,$data,TRUE);
 558     if(isset($res['XML'][0]['ITEM'])){
 559       return($res['XML'][0]['ITEM']);
 560     }
 561     return(array());
 562   }
 563
 564
 565   /*! \brief            Triggers install/reinstall of an opsi client.
 566     @param
 567     @return
 568    */
 569   public function job_opsi_install_client($hostId,$mac)
 570   {
 571     $data = array("hostId" => $hostId,"macaddress"=>$mac);
 572
 573     /* Check parameter */
 574     if(empty($hostId)){
 575       trigger_error("No valid host id given, check parameter 1.");
 576       return;
 577     }
 578
 579     /* Query SI server */
 580     $this->send_data("job_opsi_install_client",$this->target,$data,TRUE);
 581   }
 582 }
 583 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 584 ?>