<?php
/*
   This code is part of GOsa (https://gosa.gonicus.de)
   Copyright (C) 2008  Fabian Hickert

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */


/********

  __construct($config)
  get_hosts_for_system_management()
  get_netboot_products($host = "")
  get_local_products($host = "")
  get_product_properties()
  set_product_properties()
  get_client_hardware()
  get_client_software()
  list_clients()
  del_client()
  job_opsi_install_client()
  add_client()
  add_product_to_client()
  del_product_from_client()

 ********/


/*! \brief  This is the opsi base class, it handles 
  .          gosa daemon requests and prepares data for opsi plugins.
 */
class opsi extends gosaSupportDaemon 
{
  private $config = NULL;

  /*! \brief 		Create opsi object.
    @param
    @return 		
   */
  public function __construct($config)
  {
    $this->config = $config;
    gosaSupportDaemon::__construct($config);
    $this->target = "00:01:6c:9d:b9:fa";
  }

  /******************
    Opsi handling 
   ******************/

  function get_hosts_for_system_management()
  {
    $res = $this->list_clients();

    $data = array();
    foreach($res as $entry){
      $data[] = array(
        "dn"          => "opsi:=".$entry['NAME'].",".get_ou("winstations").$this->config->current['BASE'],
        "objectClass" => array("gosa_opsi_client"),
        "cn"          => array(0 => $entry['NAME']),
        "description" => array(0 => $entry['DESCRIPTION']),
        "macAddress"  => array(0 => $entry['MAC']),
        "opsi_notes"  => array(0 => $entry['NOTES']));
        
    }
  
    return($data);
  }


  /******************
    SI Communication functions
   ******************/


  /*! \brief 		Returns a list of netboot products.
    @param
    @return 		
   */
  public function get_netboot_products($host = "")
  {
    $data = array();

    /* Append host attribute to query data 
     */
    if(!empty($host)){
      $data['hostId'] = trim($host);
    }

    $res    = $this->send_data("gosa_opsi_get_netboot_products",$this->target,$data,TRUE);
    $items  = array();
    if($res['XML']['ITEM']['PRODUCTID']){
      if(!is_array($res['XML']['ITEM']['PRODUCTID'])){
        $items[$res['XML']['ITEM']['PRODUCTID']]['NAME'] = $res['XML']['ITEM']['PRODUCTID'];
        $items[$res['XML']['ITEM']['PRODUCTID']]['DESC'] = $res['XML']['ITEM']['DESCRIPTION'];
      }else{
        foreach($res['XML']['ITEM']['PRODUCTID'] as $id => $name){
          $items[$name]['NAME'] = $name;
          $items[$name]['DESC'] = $res['XML']['ITEM']['DESCRIPTION'][$id];
        }
      } 
    }
    return($items);
  }


  /*! \brief 		Returns a list of all local products.
    @param
    @return 		
   */
  public function get_local_products($host = "")
  {
    $data = array();

    /* Append host attribute to query data 
     */
    if(!empty($host)){
      $data['hostId'] = trim($host);
    }

    $res    = $this->send_data("gosa_opsi_get_local_products",$this->target,$data,TRUE);
    $items  = array();
    if($res['XML']['ITEM']['PRODUCTID']){
      if(!is_array($res['XML']['ITEM']['PRODUCTID'])){
        $items[$res['XML']['ITEM']['PRODUCTID']]['NAME'] = $res['XML']['ITEM']['PRODUCTID'];
        $items[$res['XML']['ITEM']['PRODUCTID']]['DESC'] = $res['XML']['ITEM']['DESCRIPTION'];
      }else{
        foreach($res['XML']['ITEM']['PRODUCTID'] as $id => $name){
          $items[$name]['NAME'] = $name;
          $items[$name]['DESC'] = $res['XML']['ITEM']['DESCRIPTION'][$id];
        }
      } 
    }
    return($items);
  }


  /*! \brief 		Returns a list of all product properties. \ 
    .           Additionally you can specify the host parameter to \
    .           get host specific product properties
    @param
    @return 		
   */
  public function get_product_properties($productId,$hostId = "")
  {
    $data = array("productId" => $productId);

    /* Append host attribute to query data 
     */
    if(!empty($hostId)){
      $data['hostId'] = trim($hostId);
    }
   
    /* Check parameter */ 
    if(empty($productId)){
      trigger_error("No valid product id given, check parameter 1.");
      return(array());
    }

    /* Query SI server */
    $res    = $this->send_data("gosa_opsi_get_product_properties",$this->target,$data,TRUE);
    if(isset($res['XML']['ITEM'])){   
      return($res['XML']['ITEM']);
    }
    return(array());
  }


  /*! \brief 		Set product properties, globally or per host. 
    @param
    @return 		
   */
  public function set_product_properties()
  {
    /* 	<xml> 
        <header>gosa_opsi_set_product_properties</header> 
        <source>GOSA</source> 
        <target>00:01:6c:9d:b9:fa</target> 
        <productId>firefox</productId> 
        <item>
        <name>askbeforeinst</name>
        <value>false</value>
        </item>
        </xml>
        <xml> 
        <header>gosa_opsi_set_product_properties</header> 
        <source>GOSA</source> 
        <target>00:01:6c:9d:b9:fa</target> 
        <hostId>limux-cl-2.intranet.gonicus.de</hostId> 
        <productId>firefox</productId> 
        <item> 
        <name>askbeforeinst</name> 
        <value>false</value> 
        </item> 
        </xml> 
     */
  }


  /*! \brief 		Returns the clients hardware setup.
    @param
    @return 		
   */
  public function get_client_hardware()
  {
    /*	<xml> 
        <header>gosa_opsi_get_client_hardware</header> 
        <source>GOSA</source> 
        <target>GOSA</target> 
        <hostId>limux-cl-2.intranet.gonicus.de</hostId> 
        </xml> 
     */
  }


  /*! \brief 		Returns the clients software setup.
    @param
    @return 		
   */
  public function get_client_software()
  {
    /*  <xml> 
        <header>gosa_opsi_get_client_software</header> 
        <source>GOSA</source> 
        <target>GOSA</target> 
        <hostId>limux-cl-2.intranet.gonicus.de</hostId> 
        </xml> i
     */
  }


  /*! \brief 		Returns a list of all opsi clients.
    @param
    @return 		
   */
  public function list_clients()
  {
    $data   = array();
    $res    = $this->send_data("gosa_opsi_list_clients",$this->target,$data,TRUE);
    $items  = array();
    if(isset($res['XML']['ITEM'])){
      if(!is_array($res['XML']['ITEM']['NAME'])){
        $obj = $res['XML']['ITEM'];
        $items[$obj['NAME']] = $obj;
      }else{
        foreach($res['XML']['ITEM'] as $type => $val){
          foreach($val as $key => $value){
            $items[$key][$type] = $value;
          }
        }
      }
    }
    return($items);
  }


  /*! \brief 		Deletes the given opsi client.
    @param
    @return 		
   */
  public function del_client()
  {
    /*  <xml> 
        <header>gosa_opsi_del_client</header> 
        <source>GOSA</source> 
        <target>00:01:6c:9d:b9:fa</target> 
        <hostId>limux-cl-2.intranet.gonicus.de</hostId>
        </xml>
     */
  }


  /*! \brief 		Triggers install/reinstall of an opsi client.
    @param
    @return 		
   */
  public function job_opsi_install_client()
  {
    /*  <xml> 
        <header>job_opsi_install_client</header> 
        <source>GOSA</source> 
        <target>00:01:6c:9d:b9:fa</target> 
        <hostId>limux-cl-2.intranet.gonicus.de</hostId> 
        <macaddress>00:11:25:4b:8c:e5</macaddress> 
        </xml>
     */
  }


  /*! \brief 		Adds a new opsi client.
    @param
    @return 		
   */
  public function add_client()
  {
    /*  <xml> 
        <header>gosa_opsi_add_client</header> 
        <source>GOSA</source> 
        <target>00:01:6c:9d:b9:fa</target> 
        <hostId>limux-cl-2.intranet.gonicus.de</hostId> 
        <macaddress>00:11:25:4b:8c:e5</macaddress> 
        <description>Test halt</description> 
        <ip>1.2.3.4</ip> 
        <notes>Im a note</notes> 
        </xml>
     */
  }


  /*! \brief 		Adds a given product to a client.
    @param
    @return 		
   */
  public function add_product_to_client()
  {
    /*  <xml> 
        <header>gosa_opsi_add_product_to_client</header> 
        <source>GOSA</source> 
        <target>00:01:6c:9d:b9:fa</target> 
        <macaddress>00:11:25:4b:8c:e5</macaddress> 
        <hostId>limux-cl-2.intranet.gonicus.de</hostId> 
        <productId>winxppro</productId> 
        </xml>
     */
  }


  /*! \brief      Removes a given product from a client.
    @param
    @return
   */
  public function del_product_from_client()
  {
    /* <xml> 
       <header>gosa_opsi_del_product_from_client</header> 
       <source>GOSA</source> 
       <target>00:01:6c:9d:b9:fa</target> 
       <hostId>limux-cl-1.intranet.gonicus.de</hostId> 
       <macaddress>00:11:25:4b:8c:e5</macaddress> 
       <productId>softprod</productId>  
       </xml>
     */
  }
}
// vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
?>