e4772236c32bf787a90ecef02f241493a4e3ce7e
1 <?php
2 /*
3 * This code is part of GOsa (http://www.gosa-project.org)
4 * Copyright (C) 2003-2008 GONICUS GmbH
5 *
6 * ID: $$Id$$
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
23 class gosaSupportDaemon
24 {
25 private $s_host = "";
26 private $i_port = 0;
27 private $s_encryption_key = "";
29 private $o_sock = NULL;
30 private $f_timeout = 2;
31 private $s_error = "";
32 private $b_error = FALSE;
34 private $is_connected = FALSE;
37 /*! \brief Creates a new gosaSupportDaemon object.
38 @param string Host The Host where the daemon is running on.
39 @param integer Port The port which the daemon use.
40 @param string Key The encryption string.
41 @param boolean Connect Directly connect to daemon socket.
42 @param float Timeout The timelimit for all socket actions.
43 */
44 public function __construct($connect=TRUE,$timeout=10)
45 {
46 #FIXME: bad idea about referencing global variables from within classes
47 global $config;
49 # load from config, store statically
50 if (isset($config->current['GOSA_SI'])){
52 if ($this->s_host == ""){
53 $this->s_host= preg_replace("/^.*@([^:]+):.*$/", "$1", $config->current['GOSA_SI']);
54 $this->i_port= preg_replace("/^.*@[^:]+:(.*)$/", "$1", $config->current['GOSA_SI']);
55 $this->s_encryption_key = preg_replace("/^(.*)@[^:]+:.*$/", "$1", $config->current['GOSA_SI']);
56 }
58 $this->f_timeout = $timeout;
59 if($connect){
60 $this->connect();
61 }
62 }
63 }
66 /*! \brief Establish daemon connection.
67 @return boolean Returns true if the connection was succesfully established.
68 */
69 public function connect()
70 {
71 if(!empty($this->s_host) && !empty($this->i_port)){
72 $this->o_sock = new Socket_Client($this->s_host,$this->i_port,TRUE,$this->f_timeout);
73 if($this->o_sock->connected()){
74 $this->o_sock->setEncryptionKey($this->s_encryption_key);
75 $this->is_connected = TRUE;
76 }else{
77 $this->set_error($this->o_sock->get_error());
78 $this->disconnect();
79 new log("debug","gosaSupportDaemon::connect()", "Cannot connect to si-server", array(),$this->get_error());
80 }
81 }else{
82 $this->set_error(msgPool::cmdnotfound("GOSA_SI",_("GOsa support daemon")));
83 }
84 return($this->is_connected);
85 }
88 /*! \brief Disconnect from gosa daemon.
89 */
90 public function disconnect()
91 {
92 $this->o_sock->close();
93 $this->is_connected = FALSE;
94 }
97 /*! \brief Sets an error message, which can be returned with get_error().
98 @param string The Error message,
99 */
100 private function set_error($str)
101 {
102 $this->b_error = TRUE;
103 $this->s_error = $str;
104 }
107 /*! \brief Sets an error message, which can be returned with get_error().
108 @param string The Error message,
109 */
110 private function reset_error()
111 {
112 $this->b_error = FALSE;
113 $this->s_error = "";
114 }
117 /*! \brief Checks if an error occured.
118 @return boolean returns TRUE or FALSE, whether there is an error or not.
119 */
120 public function is_error()
121 {
122 return($this->b_error);
123 }
126 /*! \brief Returns the last error.
127 @return Returns the last error.
128 */
129 public function get_error()
130 {
131 $str = $this->s_error;
132 $str = preg_replace("/ /"," ",$str);
133 return($str);
134 }
137 public function FAI_get_kernels($release)
138 {
139 $xml_msg =
140 "<xml>".
141 "<header>gosa_get_available_kernel</header>".
142 "<source>GOSA</source>".
143 "<target>GOSA</target>".
144 "<release>".$release."</release>".
145 "</xml>";
147 $ret = array();
148 if($this->connect()){
149 $this->o_sock->write($xml_msg);
150 $str = trim($this->o_sock->read());
152 /* Check if something went wrong while reading */
153 if($this->o_sock->is_error()){
154 $this->set_error($this->o_sock->get_error());
155 return($ret);
156 }
158 $entries = $this->xml_to_array($str);
159 if(isset($entries['XML']) && is_array($entries['XML'])){
161 /* Check if returned values represent a valid answer */
162 if(isset($entries['XML'])){
163 if(isset($entries['XML']['ERROR_STRING'])) {
164 $this->set_error($entries['XML']['ERROR_STRING']);
165 new log("debug","GOsa-si",
166 get_class($this)."::".__FUNCTION__, array(),
167 "FAILED error was ".$this->get_error());
168 return($ret);
169 }
171 /* Unset header tags */
172 $ret = $entries['XML'];
173 foreach($ret as $key => $entry){
174 if(!preg_match("/^answer/i",$key)){
175 unset($ret[$key]);
176 }
177 }
178 }
179 }
180 }
181 return($ret);
182 }
185 public function FAI_get_package_sections($release)
186 {
187 $xml_msg = "<xml><header>gosa_query_packages_list</header><target>GOSA</target><source>GOSA</source>".
188 "<select>distinct section</select>".
189 "<where><clause><phrase><distribution>".$release."</distribution></phrase></clause></where></xml>";
191 $ret = array();
192 if($this->connect()){
193 $this->o_sock->write($xml_msg);
194 $str = trim($this->o_sock->read());
196 /* Check if something went wrong while reading */
197 if($this->o_sock->is_error()){
198 $this->set_error($this->o_sock->get_error());
199 return($ret);
200 }
202 $entries = $this->xml_to_array($str);
203 if(isset($entries['XML']) && is_array($entries['XML'])){
205 /* Check if returned values represent a valid answer */
206 if(isset($entries['XML'])){
207 if(isset($entries['XML']['ERROR_STRING'])) {
208 $this->set_error($entries['XML']['ERROR_STRING']);
209 new log("debug","GOsa-si",
210 get_class($this)."::".__FUNCTION__, array(),
211 "FAILED error was ".$this->get_error());
212 return($ret);
213 }
215 /* Unset header tags */
216 foreach(array("HEADER","SOURCE","TARGET","SESSION_ID") as $type){
217 if(isset($entries['XML'][$type])){
218 unset($entries['XML'][$type]);
219 }
220 }
221 $ret = $entries['XML'];
222 }
223 }
224 }
225 return($ret);
226 }
229 public function FAI_get_packages($release,$attrs,$package,$from=-1,$to=-1)
230 {
231 $this->reset_error();
232 $ret = array();
234 /* Check Parameter */
235 if(!is_array($attrs) || !count($attrs)){
236 trigger_error("Second parameter must be an array. With at least one attribute name.");
237 return($ret);
238 }
240 /* Check Parameter */
241 if(!is_array($package)){
242 trigger_error("Third parameter must be an array. With at least one attribute name.");
243 return($ret);
244 }
246 /* Create list of attributes to fetch */
247 $attr = "";
248 foreach($attrs as $at){
249 $attr.= "<select>".$at."</select>";
250 }
252 /* If no package is given, search for all */
253 if(!count($package)) $package = array("%");
255 /* Create limit tag */
256 if($from == -1){
257 $limit ="";
258 }else{
259 $limit = "<limit><from>".$from."</from><to>".$to."</to></limit>";
260 }
262 /* Create list of attributes to fetch */
263 $pkgs = "";
264 foreach($package as $pkg){
265 $pkgs .="<phrase><operator>like</operator><package>".$pkg."</package></phrase>";
266 }
268 $xml_msg = "<xml><header>gosa_query_packages_list</header><target>GOSA</target><source>GOSA</source>".
269 $attr.
270 "<where>
271 <clause><phrase><distribution>".$release."</distribution></phrase></clause>
272 <clause><connector>OR</connector>
273 ".$pkgs."
274 </clause>
275 </where>".
276 $limit.
277 "</xml>";
279 if($this->connect()){
280 $this->o_sock->write($xml_msg);
281 $str = trim($this->o_sock->read());
283 /* Check if something went wrong while reading */
284 if($this->o_sock->is_error()){
285 $this->set_error($this->o_sock->get_error());
286 return($ret);
287 }
289 $entries = $this->xml_to_array($str);
290 if(isset($entries['XML']) && is_array($entries['XML'])){
292 /* Check if returned values represent a valid answer */
293 if(isset($entries['XML'])){
294 if(isset($entries['XML']['ERROR_STRING'])) {
295 $this->set_error($entries['XML']['ERROR_STRING']);
296 new log("debug","GOsa-si",
297 get_class($this)."::".__FUNCTION__, array(),
298 "FAILED error was ".$this->get_error());
299 return($ret);
300 }
302 /* Unset header tags */
303 foreach(array("HEADER","SOURCE","TARGET","SESSION_ID") as $type){
304 if(isset($entries['XML'][$type])){
305 unset($entries['XML'][$type]);
306 }
307 }
308 $ret = $entries['XML'];
309 }
310 }
311 }
312 return($ret);
315 }
318 public function FAI_get_server($name = "")
319 {
320 $this->reset_error();
322 $xml_msg = "<xml><header>gosa_query_fai_server</header><target>GOSA</target><source>GOSA</source></xml>";
323 $ret = array();
324 if($this->connect()){
325 $this->o_sock->write($xml_msg);
326 $str = trim($this->o_sock->read());
328 /* Check if something went wrong while reading */
329 if($this->o_sock->is_error()){
330 $this->set_error($this->o_sock->get_error());
331 return($ret);
332 }
334 $entries = $this->xml_to_array($str);
335 if(isset($entries['XML']) && is_array($entries['XML'])){
337 /* Check if returned values represent a valid answer */
338 if(isset($entries['XML'])){
339 if(isset($entries['XML']['ERROR_STRING'])) {
340 $this->set_error($entries['XML']['ERROR_STRING']);
341 new log("debug","GOsa-si",
342 get_class($this)."::".__FUNCTION__, array(),
343 "FAILED error was ".$this->get_error());
344 return($ret);
345 }
347 /* Unset header tags */
348 foreach(array("HEADER","SOURCE","TARGET","SESSION_ID") as $type){
349 if(isset($entries['XML'][$type])){
350 unset($entries['XML'][$type]);
351 }
352 }
353 $ret = $entries['XML'];
354 }
355 }
356 }
357 return($ret);
358 }
361 public function FAI_get_classes($name)
362 {
363 $this->reset_error();
364 $xml_msg = "<xml><header>gosa_query_fai_release</header><target>GOSA</target><source>GOSA</source>".
365 "<where><clause><phrase><release>".$name."</release></phrase></clause></where></xml>";;
366 $ret = array();
367 if($this->connect()){
368 $this->o_sock->write($xml_msg);
369 $str = trim($this->o_sock->read());
371 /* Check if something went wrong while reading */
372 if($this->o_sock->is_error()){
373 $this->set_error($this->o_sock->get_error());
374 return($ret);
375 }
377 $entries = $this->xml_to_array($str);
378 if(isset($entries['XML']) && is_array($entries['XML'])){
380 /* Check if returned values represent a valid answer */
381 if(isset($entries['XML'])){
382 if(isset($entries['XML']['ERROR_STRING'])) {
383 $this->set_error($entries['XML']['ERROR_STRING']);
384 new log("debug","GOsa-si",
385 get_class($this)."::".__FUNCTION__, array($name),
386 "FAILED error was ".$this->get_error());
387 return($ret);
388 }
390 /* Unset header tags */
391 foreach(array("HEADER","SOURCE","TARGET","SESSION_ID") as $type){
392 if(isset($entries['XML'][$type])){
393 unset($entries['XML'][$type]);
394 }
395 }
396 $ret = $entries['XML'];
397 }
398 }
399 }
400 return($ret);
401 }
404 /*! \brief Returns an array containing all queued entries.
405 @return Array All queued entries as an array.
406 */
407 public function get_queued_entries($event_types = array("*"),$from=-1,$to=-1,$sort="timestamp DESC")
408 {
409 $this->reset_error();
410 $ret = array();
412 $tags = "";
413 foreach($event_types as $type){
414 $tags .= "<phrase><headertag>".$type."</headertag></phrase>";
415 }
416 if(count($event_types) > 1){
417 $tags = "<connector>or</connector>".$tags;
418 }
419 if(count($event_types)){
420 $tags = "<where><clause>".$tags."</clause></where>";
421 }
423 $xml_msg =
424 "<xml>
425 <header>gosa_query_jobdb</header>
426 <target>GOSA</target>
427 <source>GOSA</source>
428 ".$tags."
430 <orderby>".$sort."</orderby>";
431 if($from != -1 && $to != -1){
432 $xml_msg.= "
433 <limit>
434 <from>".$from."</from>
435 <to>".$to."</to>
436 </limit>";
437 }
438 $xml_msg.= "
439 </xml>";
441 if($this->connect()){
442 $this->o_sock->write($xml_msg);
443 $str = trim($this->o_sock->read());
445 /* Check if something went wrong while reading */
446 if($this->o_sock->is_error()){
447 $this->set_error($this->o_sock->get_error());
448 return($ret);
449 }
451 $entries = $this->xml_to_array($str);
452 if(isset($entries['XML']) && is_array($entries['XML'])){
454 /* Check if returned values represent a valid answer */
455 if(isset($entries['XML'])){
457 /* Unset header tags */
458 foreach(array("HEADER","SOURCE","TARGET") as $type){
459 unset($entries['XML'][$type]);
460 }
461 $ret = $entries['XML'];
462 }
463 }
464 }
466 /* Remove session ID. No one is interested in this... */
467 unset($ret['SESSION_ID']);
469 return($ret);
470 }
473 /*! \brief Checks if the given ids are used queue ids.
474 @param Array The ids we want to check..
475 @return Array An array containing all ids as index and TRUE/FALSE as value.
476 */
477 public function ids_exist($ids)
478 {
479 if(!is_array($ids)){
480 trigger_error("Requires an array as parameter.");
481 return;
482 }
483 $this->reset_error();
485 $ret = array();
487 $xml_msg = "<xml>
488 <header>gosa_query_jobdb</header>
489 <target>GOSA</target>
490 <source>GOSA</source>
491 <where>
492 <clause>
493 <connector>or</connector>";
494 foreach($ids as $id){
495 $xml_msg .= "<phrase>
496 <operator>eq</operator>
497 <id>".$id."</id>
498 </phrase>";
499 }
500 $xml_msg .= "</clause>
501 </where>
502 </xml>";
504 if($this->connect()){
505 $this->o_sock->write($xml_msg);
506 $str = trim($this->o_sock->read());
508 /* Check if something went wrong while reading */
509 if($this->o_sock->is_error()){
510 $this->set_error($this->o_sock->get_error());
511 return($ret);
512 }
514 $entries = $this->xml_to_array($str);
515 if(isset($entries['XML']) && is_array($entries['XML'])){
516 foreach($entries['XML'] as $entry){
517 if(isset($entry['ID'])){
518 $ret[] = $entry['ID'];
519 }
520 }
521 }
522 }
523 return($ret);
524 }
527 /*! \brief Returns an entry containing all requested ids.
528 @param Array The IDs of the entries we want to return.
529 @return Array Of the requested entries.
530 */
531 public function get_entries_by_mac($macs)
532 {
533 if(!is_array($macs)){
534 trigger_error("Requires an array as parameter.");
535 return;
536 }
537 $this->reset_error();
539 $ret = array();
541 $xml_msg = "<xml>
542 <header>gosa_query_jobdb</header>
543 <target>GOSA</target>
544 <source>GOSA</source>
545 <where>
546 <clause>
547 <connector>or</connector>";
548 foreach($macs as $mac){
549 $xml_msg .= "<phrase>
550 <operator>eq</operator>
551 <macaddress>".$mac."</macaddress>
552 </phrase>";
553 }
554 $xml_msg .= "</clause>
555 </where>
556 </xml>";
558 if($this->connect()){
559 $this->o_sock->write($xml_msg);
560 $str = trim($this->o_sock->read());
562 /* Check if something went wrong while reading */
563 if($this->o_sock->is_error()){
564 $this->set_error($this->o_sock->get_error());
565 return($ret);
566 }
568 $entries = $this->xml_to_array($str);
569 if(isset($entries['XML'])){
570 foreach($entries['XML'] as $name => $entry){
571 if(preg_match("/^ANSWER[0-9]*$/",$name)){
572 $ret[$name] = $entry;
573 }
574 }
575 }
576 }
577 return($ret);
578 }
581 /*! \brief Returns an entry containing all requested ids.
582 @param Array The IDs of the entries we want to return.
583 @return Array Of the requested entries.
584 */
585 public function get_entries_by_id($ids)
586 {
587 if(!is_array($ids)){
588 trigger_error("Requires an array as parameter.");
589 return;
590 }
591 $this->reset_error();
593 $ret = array();
595 $xml_msg = "<xml>
596 <header>gosa_query_jobdb</header>
597 <target>GOSA</target>
598 <source>GOSA</source>
599 <where>
600 <clause>
601 <connector>or</connector>";
602 foreach($ids as $id){
603 $xml_msg .= "<phrase>
604 <operator>eq</operator>
605 <id>".$id."</id>
606 </phrase>";
607 }
608 $xml_msg .= "</clause>
609 </where>
610 </xml>";
612 if($this->connect()){
613 $this->o_sock->write($xml_msg);
614 $str = trim($this->o_sock->read());
616 /* Check if something went wrong while reading */
617 if($this->o_sock->is_error()){
618 $this->set_error($this->o_sock->get_error());
619 return($ret);
620 }
622 $entries = $this->xml_to_array($str);
623 if(isset($entries['XML'])){
624 foreach($entries['XML'] as $name => $entry){
625 if(preg_match("/^ANSWER[0-9]*$/",$name)){
626 $ret[$name] = $entry;
627 }
628 }
629 }
630 }
631 return($ret);
632 }
635 /*! \brief Checks if the given id is in use.
636 @param Integer The ID of the entry.
637 @return Boolean TRUE if entry exists.
638 */
639 public function id_exists($id)
640 {
641 if(!is_numeric($id)){
642 trigger_error("Requires an integer as parameter.");
643 return;
644 }
646 $this->reset_error();
648 $xml_msg = "<xml>
649 <header>gosa_query_jobdb</header>
650 <target>GOSA</target>
651 <source>GOSA</source>
652 <where>
653 <clause>
654 <phrase>
655 <operator>eq</operator>
656 <id>".$id."</id>
657 </phrase>
658 </clause>
659 </where>
660 </xml>";
662 if($this->connect()){
663 $this->o_sock->write($xml_msg);
664 $str = trim($this->o_sock->read());
666 /* Check if something went wrong while reading */
667 if($this->o_sock->is_error()){
668 $this->set_error($this->o_sock->get_error());
669 return(FALSE);
670 }
672 $entries = $this->xml_to_array($str);
673 if( isset($entries['XML']['HEADER']) &&
674 $entries['XML']['HEADER']=="answer" &&
675 isset($entries['XML']['ANSWER1'])){
676 return(TRUE);
677 }
678 }
679 return(FALSE);
680 }
683 /*! \brief Returns an entry from the gosaSupportQueue
684 @param Integer The ID of the entry we want to return.
685 @return Array Of the requested entry.
686 */
687 public function get_entry_by_id($id)
688 {
689 if(!is_numeric($id)){
690 trigger_error("Requires an integer as parameter.");
691 return;
692 }
693 $this->reset_error();
695 $ret = array();
696 $xml_msg = "<xml>
697 <header>gosa_query_jobdb</header>
698 <target>GOSA</target>
699 <source>GOSA</source>
700 <where>
701 <clause>
702 <phrase>
703 <operator>eq</operator>
704 <id>".$id."</id>
705 </phrase>
706 </clause>
707 </where>
708 </xml>";
709 if($this->connect()){
710 $this->o_sock->write($xml_msg);
711 $str = trim($this->o_sock->read());
713 /* Check if something went wrong while reading */
714 if($this->o_sock->is_error()){
715 $this->set_error($this->o_sock->get_error());
716 return($ret);
717 }
719 $entries = $this->xml_to_array($str);
720 if( isset($entries['XML']['HEADER']) &&
721 $entries['XML']['HEADER']=="answer" &&
722 isset($entries['XML']['ANSWER1'])){
723 $ret = $entries['XML']['ANSWER1'];
724 }
725 }
726 return($ret);
727 }
730 /*! \brief Removes a set of entries from the GOsa support queue.
731 @param Array The IDs to remove.
732 @return Boolean True on success.
733 */
734 public function remove_entries($ids)
735 {
736 if(!is_array($ids)){
737 trigger_error("Requires an array as parameter.");
738 return;
739 }
741 $this->reset_error();
743 $ret = array();
745 $xml_msg = "<xml>
746 <header>gosa_delete_jobdb_entry</header>
747 <target>GOSA</target>
748 <source>GOSA</source>
749 <where>
750 <clause>
751 <connector>or</connector>";
752 foreach($ids as $id){
753 $xml_msg .= "<phrase>
754 <operator>eq</operator>
755 <id>".$id."</id>
756 </phrase>";
757 }
758 $xml_msg .= "</clause>
759 </where>
760 </xml>";
762 if($this->connect()){
763 $this->o_sock->write($xml_msg);
764 $str = $this->o_sock->read();
766 /* Check if something went wrong while reading */
767 if($this->o_sock->is_error()){
768 $this->set_error($this->o_sock->get_error());
769 return($ret);
770 }
772 $entries = $this->xml_to_array($str);
773 if(isset($entries['XML']) || isset($entries['COUNT'])){
774 new log("debug","DaemonEvent (IDS) ", "gosaSupportDaemon::remove_entries()", $ids,"SUCCESS");
775 return(TRUE);
776 }else{
777 new log("debug","DaemonEvent (IDS) ", "gosaSupportDaemon::remove_entries()", $ids,"FAILED ".$this->get_error());
778 }
779 }
780 return(FALSE);
781 }
785 /*! \brief Removes an entry from the GOsa support queue.
786 @param Integer The ID of the entry we want to remove.
787 @return Boolean True on success.
788 */
789 public function remove_entry($id)
790 {
791 return($this->remove_entries(array($id)));
792 }
795 /*! \brief Parses the given xml string into an array
796 @param String XML string
797 @return Array Returns an array containing the xml structure.
798 */
799 private function xml_to_array($xml)
800 {
801 $params = array();
802 $level = array();
803 $parser = xml_parser_create_ns();
804 xml_parse_into_struct($parser, $xml, $vals, $index);
806 $err_id = xml_get_error_code($parser);
807 if($err_id){
808 xml_parser_free($parser);
809 }else{
810 xml_parser_free($parser);
812 foreach ($vals as $xml_elem) {
813 if ($xml_elem['type'] == 'open') {
814 if (array_key_exists('attributes',$xml_elem)) {
815 list($level[$xml_elem['level']],$extra) = array_values($xml_elem['attributes']);
816 } else {
817 $level[$xml_elem['level']] = $xml_elem['tag'];
818 }
819 }
820 if ($xml_elem['type'] == 'complete') {
821 $start_level = 1;
822 $test2 = &$params;
823 while($start_level < $xml_elem['level']) {
824 $test2 = &$test2[$level[$start_level]];
825 $start_level++;
826 }
827 if(!isset($test2[$xml_elem['tag']])){
828 if(isset($xml_elem['value'])){
829 $test2[$xml_elem['tag']] = $xml_elem['value'];
830 }
831 }else{
832 if(!is_array($test2[$xml_elem['tag']])){
833 $test2[$xml_elem['tag']] = array($test2[$xml_elem['tag']]);
834 }
835 $test2[$xml_elem['tag']][] = $xml_elem['value'];
836 }
837 }
838 }
839 }
841 if(!isset($params['XML'])){
842 if (!array_key_exists('XML', $params)){
843 $this->set_error(_("Cannot not parse XML!"));
844 }
845 $params = array("COUNT" => 0);
846 }
848 return($params);
849 }
852 /*! \brief Updates an entry with a set of new values,
853 @param Integer The ID of the entry, we want to update.
854 @param Array The variables to update.
855 @return Boolean Returns TRUE on success.
856 */
857 public function update_entries($ids,$data)
858 {
859 $this->reset_error();
860 if(!is_array($ids)){
861 trigger_error("Requires an array as first parameter.");
862 return;
863 }
865 if(!is_array($data)){
866 trigger_error("Requires an array as second parameter.");
867 return;
868 }
870 $attr = "";
871 foreach($data as $key => $value){
872 if(is_array($value)){
873 foreach($value as $sub_value){
874 $attr.= "<$key>".strtolower($sub_value)."</$key>\n";
875 }
876 }else{
877 $attr.= "<$key>".strtolower($value)."</$key>\n";
878 }
879 }
881 $xml_msg = "<xml>
882 <header>gosa_update_status_jobdb_entry</header>
883 <target>GOSA</target>
884 <source>GOSA</source>
885 <where>
886 <clause>
887 <connector>or</connector>";
888 foreach($ids as $id){
889 $xml_msg .= "<phrase>
890 <operator>eq</operator>
891 <id>".$id."</id>
892 </phrase>";
893 }
894 $xml_msg .= "</clause>
895 </where>
896 <update>
897 ".$attr."
898 </update>
899 </xml>";
901 if($this->connect()){
903 $this->o_sock->write($xml_msg);
904 $str = trim($this->o_sock->read());
906 /* Check if something went wrong while reading */
907 if($this->o_sock->is_error()){
908 $this->set_error($this->o_sock->get_error());
909 return(FALSE);
910 }
912 $entries = $this->xml_to_array($str);
913 if(isset($entries['XML'])){
914 if(isset($entries['XML']['ERROR_STRING'])) {
915 $this->set_error($entries['XML']['ERROR_STRING']);
916 new log("debug","DaemonEvent (IDS) ", "gosaSupportDaemon::update_entries()", $ids,"FAILED setting (".$attr.") error was ".$this->get_error());
917 return(FALSE);
918 }
919 new log("debug","DaemonEvent (IDS) ", "gosaSupportDaemon::update_entries()", $ids,"SUCCESS");
920 return(TRUE);
921 }
922 }
923 return(FALSE);
924 }
927 /*! \brief Returns the number of currently queued objects.
928 @return Integer
929 */
930 public function number_of_queued_entries($event_types)
931 {
932 $tags = "";
933 foreach($event_types as $type){
934 $tags .= "<phrase><headertag>".$type."</headertag></phrase>";
935 }
936 if(count($event_types) > 1){
937 $tags = "<connector>or</connector>".$tags;
938 }
939 if(count($event_types)){
940 $tags = "<where><clause>".$tags."</clause></where>";
941 }
944 $xml_msg =
945 "<xml>".
946 "<header>gosa_query_jobdb</header>".
947 "<target>GOSA</target>".
948 "<source>GOSA</source>".
949 "<select> count ID</select>".
950 $tags.
951 "</xml>";
953 $xml_msg ="<xml><header>gosa_count_jobdb</header><target>GOSA</target><source>GOSA</source></xml>";
954 $this->connect();
955 if($this->connect()){
956 $this->o_sock->write($xml_msg);
957 $str = trim($this->o_sock->read());
959 /* Check if something went wrong while reading */
960 if($this->o_sock->is_error()){
961 $this->set_error($this->o_sock->get_error());
962 return(0);
963 }
965 $entries = $this->xml_to_array($str);
966 if(isset($entries['XML'])){
967 return($entries['XML']['COUNT']);
968 }
969 }
970 return(-1);
971 }
974 public function send_data($header, $to, $data= array(), $answer_expected = FALSE)
975 {
976 $xml_message= "";
978 /* Prepare data */
979 foreach ($data as $key => $value){
980 if(is_array($value)){
981 foreach($value as $sub_value){
982 $xml_message.= "<$key>$sub_value</$key>";
983 }
984 }else{
985 $xml_message.= "<$key>$value</$key>";
986 }
987 }
989 /* Multiple targets? */
990 if (!is_array($to)){
991 $to_targets= array($to);
992 } else {
993 $to_targets= $to;
994 }
996 /* Build target strings */
997 $target ="";
998 foreach($to_targets as $to){
999 $target.= "<target>$to</target>";
1000 }
1002 return $this->_send("<xml><header>$header</header><source>GOSA</source>$target".$xml_message."</xml>",$answer_expected);
1003 }
1006 /* Allows simply appending a new DaemonEvent
1007 */
1008 public function append($event)
1009 {
1010 if(!($event instanceof DaemonEvent)){
1011 return(FALSE);
1012 }
1014 $this->reset_error();
1016 /* Add to queue if new
1017 */
1018 if($event->is_new()){
1020 $request_answer = FALSE;
1021 if($event->get_type() == SCHEDULED_EVENT){
1022 $action = $event->get_schedule_action();
1023 }elseif($event->get_type() == TRIGGERED_EVENT){
1024 $action = $event->get_trigger_action();
1025 }else{
1026 trigger_error("Unknown type of queue event given.");
1027 return(FALSE);
1028 }
1030 /* Get event informations, like targets..
1031 */
1032 $targets = $event->get_targets();
1033 $data = $event->save();
1035 /* Append an entry for each target
1036 */
1037 foreach($targets as $target){
1038 $data['macaddress'] = $target;
1039 $this->send_data($action,$target,$data,$request_answer);
1041 if($this->is_error()){
1042 return(FALSE);
1043 }
1044 }
1045 return(TRUE);
1046 }else{
1048 /* Updated edited entry.
1049 */
1050 $id = $event->get_id();
1051 $data = $event->save();
1052 return($this->update_entries(array($id),$data));
1053 }
1055 return(FALSE);
1056 }
1059 /*! \brief Returns an array containing all queued entries.
1060 @return Array All queued entries as an array.
1061 */
1062 public function _send($data, $answer_expected= FALSE)
1063 {
1064 $this->reset_error();
1065 $ret = array();
1067 if($this->connect()){
1068 $this->o_sock->write($data);
1069 if ($answer_expected){
1070 $str = trim($this->o_sock->read());
1072 /* Check if something went wrong while reading */
1073 if($this->o_sock->is_error()){
1074 $this->set_error($this->o_sock->get_error());
1075 return($ret);
1076 }
1078 $entries = $this->xml_to_array($str);
1079 if(isset($entries['XML']) && is_array($entries['XML'])){
1080 $ret = $entries;
1081 if(isset($entries['XML']['ERROR_STRING'])) {
1082 $this->set_error($entries['XML']['ERROR_STRING']);
1083 new log("debug","DaemonEvent (IDS) ", "gosaSupportDaemon::_send()", array($data=>$data),"FAILED ".$this->get_error());
1084 }elseif(isset($entries['XML']['ERROR'])){
1085 $this->set_error($entries['XML']['ERROR']);
1086 new log("debug","DaemonEvent (IDS) ", "gosaSupportDaemon::_send()", array($data=>$data),"FAILED ".$this->get_error());
1087 }else{
1088 new log("debug","DaemonEvent (IDS) ", "gosaSupportDaemon::_send()", array($data=>$data),"SUCCESS");
1089 }
1090 }
1091 }else{
1092 new log("debug","DaemonEvent (IDS) ", "gosaSupportDaemon::_send()", array($data=>$data),"Fire & forget, not result.! ".$this->get_error());
1093 }
1094 }
1095 return($ret);
1096 }
1099 static function send($header, $to, $data= array(), $answer_expected = FALSE)
1100 {
1101 $xml_message= "";
1103 /* Get communication object */
1104 $d= new gosaSupportDaemon(TRUE,10);
1106 /* Prepare data */
1107 foreach ($data as $key => $value){
1108 if(is_array($value)){
1109 foreach($value as $sub_val){
1110 $xml_message.= "<$key>$sub_value</$key>";
1111 }
1112 }else{
1113 $xml_message.= "<$key>$value</$key>";
1114 }
1115 }
1117 /* Multiple targets? */
1118 if (!is_array($to)){
1119 $to_targets= array($to);
1120 } else {
1121 $to_targets= $to;
1122 }
1124 /* Build target strings */
1125 $target ="";
1126 foreach($to_targets as $to){
1127 $target.= "<target>$to</target>";
1128 }
1130 return $d->_send("<xml><header>$header</header><source>GOSA</source>$target".$xml_message."</xml>",$answer_expected);
1131 }
1134 /*! \brief Removes all jobs from the queue that are tiggered with a specific macAddress.
1135 @param String $mac The mac address for which we want to remove all jobs.
1136 */
1137 function clean_queue_from_mac($mac)
1138 {
1139 global $config;
1141 /* First of all we have to check which jobs are startet
1142 * for $mac
1143 */
1144 $xml_msg ="<xml><header>gosa_query_jobdb</header><target>GOSA</target><source>GOSA</source><where><clause><phrase><macaddress>".$mac."</macaddress></phrase></clause></where></xml>";
1146 new log("debug","DaemonEvent ", "gosaSupportDaemon::clean_queue_from_mac()", array($mac => $mac)," start cleaning.");
1148 $data = $this->_send($xml_msg,TRUE);
1149 if(is_array($data) && isset($data['XML'])){
1150 $already_aborted = FALSE;
1151 foreach($data['XML'] as $name => $entry){
1152 if(preg_match("/answer[0-9]*/i",$name)){
1153 $entry['STATUS'] = strtoupper($entry['STATUS']);
1154 switch($entry['STATUS']){
1156 case 'PROCESSING' :
1158 /* Send abort event, but only once
1159 */
1160 if($already_aborted){
1161 break;
1162 }elseif(class_available("DaemonEvent_faireboot")){
1163 $already_aborted = TRUE;
1164 $tmp = new DaemonEvent_faireboot($config);
1165 $tmp->add_targets(array($mac));
1166 $tmp->set_type(TRIGGERED_EVENT);
1167 if(!$this->append($tmp)){
1168 msg_dialog::display(_("Error"), sprintf(_("Cannot send abort event for entry %s!"),$entry['ID']) , ERROR_DIALOG);
1169 new log("debug","DaemonEvent ", "gosaSupportDaemon::clean_queue_from_mac()", array($mac => $mac),
1170 "FAILED, could not send 'DaemonEvent_faireboot' for entry ID (".$entry['ID'].") - ".$this->get_error());
1171 }else{
1172 new log("debug","DaemonEvent ", "gosaSupportDaemon::clean_queue_from_mac()", array($mac => $mac),
1173 "SUCCESS, send 'DaemonEvent_faireboot' for entry ID (".$entry['ID'].")");
1174 }
1175 ;break;
1176 }else{
1177 /* Couldn't find abort event, just remove entry */
1178 }
1180 case 'WAITING':
1181 case 'ERROR':
1182 default :
1184 /* Simply remove entries from queue.
1185 * Failed or waiting events, can be removed without any trouble.
1186 */
1187 if(!$this->remove_entries(array($entry['ID']))){
1188 msg_dialog::display(_("Error"), sprintf(_("Cannot remove entry %s!"),$entry['ID']) , ERROR_DIALOG);
1189 }
1190 ;break;
1191 }
1193 }
1194 }
1195 }
1196 }
1199 static function ping($target)
1200 {
1201 if (tests::is_mac($target)){
1202 /* Get communication object */
1203 $d= new gosaSupportDaemon(TRUE,0.5);
1204 $answer= $d->_send("<xml><header>gosa_ping</header><source>GOSA</source><target>$target</target></xml>", TRUE);
1205 return (count($answer) ? TRUE:FALSE);
1206 }
1207 return (FALSE);
1208 }
1212 /*! \brief Returns a list of all configured principals.
1213 (Uses the GOsa support daemon instead of the ldap database.)
1214 @return Array A list containing the names of all configured principals.
1215 */
1216 public function krb5_list_principals($server)
1217 {
1218 $res = array();
1220 /* Check if the given server is a valid mac address
1221 */
1222 if(!tests::is_mac($server)){
1223 trigger_error("The given server address '".$server."' is invalid, it must be a valid mac address");
1224 return($ret);
1225 }
1227 /* Prepare request event
1228 */
1229 $xml_msg =
1230 "<xml>".
1231 "<header>gosa_krb5_list_principals</header>".
1232 "<source>GOSA</source>".
1233 "<target>".$server."</target>".
1234 "</xml>";
1236 return($this->_send($xml_msg,TRUE));
1237 }
1240 /*! \brief Returns the configuration settings for a given principal name.
1241 (Uses the GOsa support daemon instead of the ldap database.)
1242 @pram String The name of the requested principal. (e.g. peter@EXAMPLE.DE)
1243 @return Array A list containing the names of all configured principals.
1244 */
1245 public function krb5_get_principal($server,$name)
1246 {
1247 $ret = array();
1249 /* Check if the given name is a valid request value
1250 */
1251 if(!is_string($name) || empty($name)){
1252 trigger_error("The given principal name is not of type string or it is empty.");
1253 return($ret);
1254 }
1256 /* Check if the given server is a valid mac address
1257 */
1258 if(!tests::is_mac($server)){
1259 trigger_error("The given server address '".$server."' is invalid, it must be a valid mac address");
1260 return($ret);
1261 }
1263 /* Prepare request event
1264 */
1265 $xml_msg =
1266 "<xml>".
1267 "<header>gosa_krb5_get_principal</header>".
1268 "<principal>".$name."</principal>".
1269 "<source>GOSA</source>".
1270 "<target>GOSA</target>".
1271 "</xml>";
1273 return($this->_send($xml_msg,TRUE));
1274 }
1277 /*! \brief Creates/Updates a given principal with a set of configuration settings.
1278 For a list of configurable attributes have a look at 'krb5_get_principal()'.
1279 (Uses the GOsa support daemon instead of the ldap database.)
1280 @pram String The name of the principal to update. (e.g. peter@EXAMPLE.DE)
1281 @return Boolean TRUE on success else FALSE.
1282 */
1283 public function krb5_set_principal($server,$name,$values)
1284 {
1285 $ret = FALSE;
1287 /* Check if the given name is a valid request value
1288 */
1289 if(!is_string($name) || empty($name)){
1290 trigger_error("The given principal name is not of type string or it is empty.");
1291 return($ret);
1292 }
1293 if(!is_array($values) || !count($values)){
1294 trigger_error("No valid update settings given. The parameter must be of type array and must contain at least one entry");
1295 return($ret);
1296 }
1298 /* Check if the given server is a valid mac address
1299 */
1300 if(!tests::is_mac($server)){
1301 trigger_error("The given server address '".$server."' is invalid, it must be a valid mac address");
1302 return($ret);
1303 }
1305 $attrs = "";
1306 foreach($values as $name => $value){
1307 if(empty($name) || is_numeric($name)){
1308 trigger_error("Invalid configuration attribute given '".$name."=".$value."'.");
1309 return($ret);
1310 }
1311 $attrs = "<$name>$value</$name>\n";
1312 }
1314 /* Prepare request event
1315 */
1316 $xml_msg =
1317 "<xml>".
1318 "<header>gosa_krb5_set_principal</header>".
1319 "<principal>".$name."</principal>".
1320 $attrs.
1321 "<source>GOSA</source>".
1322 "<target>GOSA</target>".
1323 "</xml>";
1325 return($this->_send($xml_msg,TRUE) == TRUE && !$this->is_error());
1326 }
1329 /*! \brief Removes the given principal.
1330 (Uses the GOsa support daemon instead of the ldap database.)
1331 @pram String The name of the principal. (e.g. peter@EXAMPLE.DE)
1332 @return Boollean TRUE on success else FALSE
1333 */
1334 public function krb5_del_principal($server,$name)
1335 {
1336 $ret = FALSE;
1338 /* Check if the given name is a valid request value
1339 */
1340 if(!is_string($name) || empty($name)){
1341 trigger_error("The given principal name is not of type string or it is empty.");
1342 return($ret);
1343 }
1345 /* Check if the given server is a valid mac address
1346 */
1347 if(!tests::is_mac($server)){
1348 trigger_error("The given server address '".$server."' is invalid, it must be a valid mac address");
1349 return($ret);
1350 }
1352 /* Prepare request event
1353 */
1354 $xml_msg =
1355 "<xml>".
1356 "<header>gosa_krb5_del_principal</header>".
1357 "<principal>".$name."</principal>".
1358 "<source>GOSA</source>".
1359 "<target>GOSA</target>".
1360 "</xml>";
1362 return($this->_send($xml_msg,TRUE) == TRUE && !$this->is_error());
1363 }
1366 /*! \brief Returns a list of configured password policies.
1367 (Uses the GOsa support daemon instead of the ldap database.)
1368 @return Array A list of all configured password policies.
1369 */
1370 public function krb5_list_policies($server)
1371 {
1372 $res = array();
1374 /* Check if the given server is a valid mac address
1375 */
1376 if(!tests::is_mac($server)){
1377 trigger_error("The given server address '".$server."' is invalid, it must be a valid mac address");
1378 return($ret);
1379 }
1381 /* Prepare request event
1382 */
1383 $xml_msg =
1384 "<xml>".
1385 "<header>gosa_krb5_list_policies</header>".
1386 "<source>GOSA</source>".
1387 "<target>".$server."</target>".
1388 "</xml>";
1390 $res = $this->_send($xml_msg,TRUE);
1392 /* Check if there are results for POLICY
1393 */
1394 if(isset($res['XML']['POLICY'])){
1396 /* Ensure that we return an array
1397 */
1398 $tmp = $res['XML']['POLICY'];
1399 if(!is_array($tmp)){
1400 $tmp = array($tmp);
1401 }
1402 return($tmp);
1403 }else{
1404 return(array());
1405 }
1406 }
1409 /*! \brief Returns a list of configured password policies.
1410 (Uses the GOsa support daemon instead of the ldap database.)
1411 @return Array The policy settings for the given policy name.
1412 */
1413 public function krb5_get_policy($server,$name)
1414 {
1415 $res = array();
1417 /* Check if the given name is a valid request value
1418 */
1419 if(!is_string($name) || empty($name)){
1420 trigger_error("The given policy name is not of type string or it is empty.");
1421 return($ret);
1422 }
1424 /* Check if the given server is a valid mac address
1425 */
1426 if(!tests::is_mac($server)){
1427 trigger_error("The given server address '".$server."' is invalid, it must be a valid mac address");
1428 return($ret);
1429 }
1431 /* Prepare request event
1432 */
1433 $xml_msg =
1434 "<xml>".
1435 "<header>gosa_krb5_get_policy</header>".
1436 "<policy>".$name."</policy>".
1437 "<source>GOSA</source>".
1438 "<target>".$server."</target>".
1439 "</xml>";
1441 /* Possible attributes */
1442 $attrs = array("MASK","POLICY","PW_HISTORY_NUM","PW_MAX_LIFE",
1443 "PW_MIN_CLASSES","PW_MIN_LENGTH","PW_MIN_LIFE","POLICY_REFCNT");
1446 $tmp = $this->_send($xml_msg,TRUE);
1447 if(isset($tmp['XML'])){
1448 foreach($attrs as $attr){
1449 if(isset($tmp['XML'][$attr])){
1450 $ret[$attr] = $tmp['XML'][$attr];
1451 }else{
1452 $ret[$attr] = "";
1453 }
1454 }
1455 }
1456 return($ret);
1457 }
1460 /*! \brief Creates a new policy with a given set of configuration settings.
1461 For a list of configurable attributes have a look at 'krb5_get_policy()'.
1462 (Uses the GOsa support daemon instead of the ldap database.)
1463 @pram String The name of the policy to update.
1464 @pram Array The attributes to update
1465 @return Boolean TRUE on success else FALSE.
1466 */
1467 public function krb5_add_policy($server,$name,$values)
1468 {
1469 $ret = FALSE;
1471 /* Check if the given name is a valid request value
1472 */
1473 if(!is_string($name) || empty($name)){
1474 trigger_error("The given policy name is not of type string or it is empty.");
1475 return($ret);
1476 }
1477 if(!is_array($values) || !count($values)){
1478 trigger_error("No valid policy settings given. The parameter must be of type array and must contain at least one entry");
1479 return($ret);
1480 }
1482 /* Check if the given server is a valid mac address
1483 */
1484 if(!tests::is_mac($server)){
1485 trigger_error("The given server address '".$server."' is invalid, it must be a valid mac address");
1486 return($ret);
1487 }
1490 /* Transform array into <xml>
1491 */
1492 $attrs = "";
1493 foreach($values as $id => $value){
1494 if(empty($id) || is_numeric($id)){
1495 trigger_error("Invalid policy configuration attribute given '".$id."=".$value."'.");
1496 return($ret);
1497 }
1498 $attrs.= "<$id>$value</$id>\n";
1499 }
1501 /* Prepare request event
1502 */
1503 $xml_msg =
1504 "<xml>".
1505 "<header>gosa_krb5_create_policy</header>".
1506 "<policy>".$name."</policy>".
1507 $attrs.
1508 "<source>GOSA</source>".
1509 "<target>".$server."</target>".
1510 "</xml>";
1512 return($this->_send($xml_msg,TRUE) == TRUE && !$this->is_error());
1513 }
1516 /*! \brief Updates a given policy with a set of configuration settings.
1517 For a list of configurable attributes have a look at 'krb5_get_policy()'.
1518 (Uses the GOsa support daemon instead of the ldap database.)
1519 @pram String The name of the policy to update.
1520 @return Boolean TRUE on success else FALSE.
1521 */
1522 public function krb5_set_policy($server,$name,$values)
1523 {
1524 $ret = FALSE;
1526 /* Check if the given name is a valid request value
1527 */
1528 if(!is_string($name) || empty($name)){
1529 trigger_error("The given policy name is not of type string or it is empty.");
1530 return($ret);
1531 }
1532 if(!is_array($values) || !count($values)){
1533 trigger_error("No valid policy settings given. The parameter must be of type array and must contain at least one entry");
1534 return($ret);
1535 }
1537 /* Check if the given server is a valid mac address
1538 */
1539 if(!tests::is_mac($server)){
1540 trigger_error("The given server address '".$server."' is invalid, it must be a valid mac address");
1541 return($ret);
1542 }
1544 /* Transform array into <xml>
1545 */
1546 $attrs = "";
1547 foreach($values as $id => $value){
1548 if(preg_match("/^policy$/i",$id)) continue;
1549 if(empty($id) || is_numeric($id)){
1550 trigger_error("Invalid policy configuration attribute given '".$id."=".$value."'.");
1551 return($ret);
1552 }
1553 $attrs.= "<$id>$value</$id>\n";
1554 }
1556 /* Prepare request event
1557 */
1558 $xml_msg =
1559 "<xml>".
1560 "<header>gosa_krb5_modify_policy</header>".
1561 "<policy>".$name."</policy>".
1562 $attrs.
1563 "<source>GOSA</source>".
1564 "<target>".$server."</target>".
1565 "</xml>";
1567 return($this->_send($xml_msg,TRUE) == TRUE && !$this->is_error());
1568 }
1571 /*! \brief Removes the given password policy.
1572 (Uses the GOsa support daemon instead of the ldap database.)
1573 @return Boolean TRUE on success else FALSE
1574 */
1575 public function krb5_del_policy($server,$name)
1576 {
1577 $ret = FALSE;
1579 /* Check if the given server is a valid mac address
1580 */
1581 if(!tests::is_mac($server)){
1582 trigger_error("The given server address '".$server."' is invalid, it must be a valid mac address");
1583 return($ret);
1584 }
1586 /* Check if the given name is a valid request value
1587 */
1588 if(!is_string($name) || empty($name)){
1589 trigger_error("The given policy name is not of type string or it is empty.");
1590 return($ret);
1591 }
1593 /* Prepare request event
1594 */
1595 $xml_msg =
1596 "<xml>".
1597 "<header>gosa_krb5_del_policy</header>".
1598 "<policy>".$name."</policy>".
1599 "<source>GOSA</source>".
1600 "<target>GOSA</target>".
1601 "</xml>";
1602 return($this->_send($xml_msg,TRUE) == TRUE && !$this->is_error());
1603 }
1605 }
1607 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
1608 ?>