1 <?php
2 /*
3 This code is part of GOsa (https://gosa.gonicus.de)
4 Copyright (C) 2008 Fabian Hickert
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.
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.
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 */
21 /********
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)
42 ********/
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 = "";
54 /*! \brief Create opsi object.
55 @param
56 @return
57 */
58 public function __construct($config)
59 {
60 $this->config = $config;
61 gosaSupportDaemon::__construct($config);
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");
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 }
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 }
91 /******************
92 Opsi handling
93 ******************/
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']));
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 }
120 return($data);
121 }
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 }
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 }
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 }
162 /******************
163 SI Communication functions
164 ******************/
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 }
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);
192 if(empty($hostId)){
193 trigger_error("No valid host id given, check parameter 1.");
194 return;
195 }
197 /* Add optional attributes */
198 foreach(array("notes","description") as $attr) {
199 if(!empty($$attr)){
200 $data[$attr] = $$attr;
201 }
202 }
204 /* Query SI server */
205 $res = $this->send_data("gosa_opsi_add_client",$this->target,$data,TRUE);
206 }
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);
217 if(empty($hostId)){
218 trigger_error("No valid host id given, check parameter 1.");
219 return;
220 }
222 /* Add optional attributes */
223 foreach(array("notes","description") as $attr) {
224 $data[$attr] = $$attr;
225 }
227 /* Query SI server */
228 $res = $this->send_data("gosa_opsi_modify_client",$this->target,$data,TRUE);
229 }
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 }
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 }
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 }
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 }
285 /*! \brief Returns a list of all product properties. \
286 . Additionally you can specify the host parameter to \
287 . get host specific product properties
288 @param
289 @return
290 */
291 public function get_product_properties($productId,$hostId = "")
292 {
293 $data = array("productId" => $productId);
295 /* Append host attribute to query data
296 */
297 if(!empty($hostId)){
298 $data['hostId'] = trim($hostId);
299 }
301 /* Check parameter */
302 if(empty($productId)){
303 trigger_error("No valid product id given, check parameter 1.");
304 return(array());
305 }
307 /* Query SI server */
308 $res = $this->send_data("gosa_opsi_get_product_properties",$this->target,$data,TRUE);
309 $items = array();
310 if(isset($res['XML'][0]['ITEM'])){
311 foreach($res['XML'][0]['ITEM'] as $entry){
312 foreach($entry as $name => $val){
314 foreach(array("DESCRIPTION","DEFAULT") as $attr){
315 $items[$name][$attr] = "";
316 if(isset($val[0][$attr])){
317 $items[$name][$attr] = $val[0][$attr][0]['VALUE'];
318 }
319 }
320 $items[$name]['VALUE'] = array();
321 if(isset($val['0']['VALUE'])){
322 foreach($val['0']['VALUE'] as $value){
323 $items[$name]['VALUE'][] = $value['VALUE'];
324 }
325 }
326 $items[$name]['VALUE_CNT'] = count($items[$name]['VALUE']);
327 }
328 }
329 }
330 return($items);
331 }
334 /*! \brief Set product properties, globally or per host.
335 @param
336 @return
337 */
338 public function set_product_properties($productId,$cfg,$hostId = "")
339 {
340 $data = array("productId" => $productId);
342 /* Append host attribute to query data
343 */
344 if(!empty($hostId)){
345 $data['hostId'] = trim($hostId);
346 }
348 /* Check parameter */
349 if(empty($productId)){
350 trigger_error("No valid product id given, check parameter 1.");
351 return(array());
352 }
354 if(!count($cfg)) return;
356 /* Add properties */
357 $data['item'] = array();
358 foreach($cfg as $name => $value){
359 $data['item'][] = "<name>".$name."</name><value>".$value['DEFAULT']."</value>";
360 }
362 /* Query SI server */
363 $res = $this->send_data("gosa_opsi_set_product_properties",$this->target,$data,TRUE);
364 }
367 /*! \brief Adds a given product to a client.
368 @param
369 @return
370 */
371 public function add_product_to_client($productId,$hostId)
372 {
373 $data = array("productId" => $productId,"hostId" => $hostId);
375 /* Check parameter */
376 if(empty($productId)){
377 trigger_error("No valid product id given, check parameter 1.");
378 return;
379 }
380 if(empty($hostId)){
381 trigger_error("No valid host id given, check parameter 2.");
382 return;
383 }
385 /* Query SI server */
386 $res = $this->send_data("gosa_opsi_add_product_to_client",$this->target,$data,TRUE);
387 }
390 /*! \brief Removes a given product from a client.
391 @param
392 @return
393 */
394 public function del_product_from_client($productId,$hostId)
395 {
396 $data = array("productId" => $productId,"hostId" => $hostId);
398 /* Check parameter */
399 if(empty($productId)){
400 trigger_error("No valid product id given, check parameter 1.");
401 return;
402 }
403 if(empty($hostId)){
404 trigger_error("No valid host id given, check parameter 2.");
405 return;
406 }
408 /* Query SI server */
409 $res = $this->send_data("gosa_opsi_del_product_from_client",$this->target,$data,TRUE);
410 }
413 /*! \brief Returns the clients hardware setup.
414 @param
415 @return
416 */
417 public function get_client_hardware($hostId)
418 {
419 $data = array("hostId" => $hostId);
421 /* Check parameter */
422 if(empty($hostId)){
423 trigger_error("No valid host id given, check parameter 1.");
424 return;
425 }
427 /* Query SI server */
428 $res = $this->send_data("gosa_opsi_get_client_hardware",$this->target,$data,TRUE);
429 if(isset($res['XML'][0]['ITEM'])){
430 return($res['XML'][0]['ITEM']);
431 }
432 return(array());
433 }
436 /*! \brief Returns the clients software setup.
437 @param
438 @return
439 */
440 public function get_client_software($hostId)
441 {
442 $data = array("hostId" => $hostId);
444 /* Check parameter */
445 if(empty($hostId)){
446 trigger_error("No valid host id given, check parameter 1.");
447 return;
448 }
450 /* Query SI server */
451 $res = $this->send_data("gosa_opsi_get_client_software",$this->target,$data,TRUE);
452 if(isset($res['XML'][0]['ITEM'])){
453 return($res['XML'][0]['ITEM']);
454 }
455 return(array());
456 }
460 /*! \brief Deletes the given opsi client.
461 @param
462 @return
463 */
464 public function del_client($hostId)
465 {
466 $data = array("hostId" => $hostId);
468 /* Check parameter */
469 if(empty($hostId)){
470 trigger_error("No valid host id given, check parameter 1.");
471 return;
472 }
474 /* Query SI server */
475 $res = $this->send_data("gosa_opsi_del_client",$this->target,$data,TRUE);
476 if(isset($res['XML'][0]['ITEM'])){
477 return($res['XML'][0]['ITEM']);
478 }
479 return(array());
480 }
483 /*! \brief Triggers install/reinstall of an opsi client.
484 @param
485 @return
486 */
487 public function job_opsi_install_client($hostId,$mac)
488 {
489 $data = array("hostId" => $hostId,"macaddress"=>$mac);
491 /* Check parameter */
492 if(empty($hostId)){
493 trigger_error("No valid host id given, check parameter 1.");
494 return;
495 }
497 /* Query SI server */
498 $this->send_data("job_opsi_install_client",$this->target,$data,TRUE);
499 }
500 }
501 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
502 ?>