include/class_hostActionQueue.inc

   1 <?php
   2 /*
   3    This code is part of GOsa (https://gosa.gonicus.de)
   4    Copyright (C) 2007  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 2 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, write to the Free Software
  18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21
  22 /*!
  23   \brief   This class represents the host action queue.
  24   \author  Fabian Hickert <hickert@gonicus.de>
  25   \version 2.6
  26   \date    24.10.2007
  27
  28   This class is a queue handler, which allows adding,removing,
  29    priority settings,stop and resume actions... for each queue entry
  30  */
  31 class hostActionQueue {
  32
  33   private $o_config       = NULL;
  34   private $s_queue_file   = "";
  35   private $s_error        = "";
  36   private $b_error        = FALSE;
  37
  38   private $a_queue        = array();
  39   private $i_pointer      = 0;
  40   private $b_queue_loaded = false;
  41   private $i_fileversion  = 0;
  42
  43   private $id_entry_map   = array();
  44
  45   public function __construct($config)
  46   {
  47     $this->o_config= $config;
  48
  49     /* Define source file */
  50     $this->s_queue_file = CONFIG_DIR."/gotomasses_machines";
  51
  52     $file = $this->o_config->search("gotomasses", "STORAGE_FILE",array('menu'));
  53     if(!empty($file)){
  54       $this->s_queue_file = $file;
  55     }
  56   }
  57
  58   private function _reload_queue()
  59   {
  60     $this->_reset_error();
  61     $this->b_queue_loaded = FALSE;
  62     $this->b_error        = FALSE;
  63     $this->s_error        = "";
  64     $this->i_pointer      = 0;
  65
  66     /* Check file accessibility */
  67     if(!file_exists($this->s_queue_file)){
  68       $this->set_error(sprintf(_("Can't locate gotomasses queue file '%s'."),$this->s_queue_file));
  69       return(FALSE);
  70     }
  71     if(!is_readable($this->s_queue_file)){
  72       $this->set_error(sprintf(_("Can't read gotomasses queue file '%s'."),$this->s_queue_file));
  73       return(FALSE);
  74     }
  75
  76     /* Check if file contents could be read */
  77     $fp = @fopen($this->s_queue_file,"r");
  78     if(!$fp){
  79       $this->set_error(sprintf(_("Can't read gotomasses storage file '%s'."),$this->s_queue_file));
  80       return(FALSE);
  81     }
  82     $this->i_fileversion = filemtime($this->s_queue_file);
  83     echo $this->i_fileversion."reload<br>";
  84
  85     /* Get file contents */
  86     $data ="";
  87     while(!feof($fp)){
  88       $data.= fread($fp,512);
  89     }
  90
  91     /* Get lines from file */
  92     $this->a_queue  = array();
  93     $comment        = "";
  94     $rows           = split("\n",$data);
  95
  96     $used_ids = array();
  97
  98     /* Walk trough rows and parse data */
  99     foreach($rows as $row){
 100
 101       /* Skip empty lines */
 102       $row = trim($row);
 103       if(empty($row)){
 104         continue;
 105       }
 106
 107       /* Get comment, if available */
 108       if(preg_match("/^#/",$row)){
 109         $comment = preg_replace("/^#/","",$row);
 110         continue;
 111       }
 112
 113       $entry_id = $taks_id= 0;
 114
 115       /* Comment must be set correctly */
 116       if(empty($comment)){
 117         $desc     = "";
 118       }else{
 119         $task_id =preg_replace("/^.*taskid:([0-9]*).*$/","\\1",$comment);
 120         $entry_id=preg_replace("/^.*entryid:([0-9]*).*$/","\\1",$comment);
 121         $desc    =preg_replace("/^.*desc:(.*)$/","\\1",$comment);
 122       }
 123       if($task_id == 0 || !is_numeric($task_id)){
 124         $task_id  = preg_replace("/[^0-9]*/","",microtime());
 125       }
 126       if($entry_id == 0 || !is_numeric($entry_id)){
 127         $entry_id = preg_replace("/[^0-9]*/","",microtime());
 128       }
 129
 130       /* Get unige id */
 131       while(in_array($entry_id,$used_ids)){
 132         $entry_id = preg_replace("/[^0-9]*/","",microtime());
 133       }
 134       $used_ids[] = $entry_id;
 135
 136       /* Split row into minutes/ hours ...*/
 137       $row    = preg_replace('/[\t ]/umi'," ",$row);
 138       $row    = preg_replace('/  */umi'," ",$row);
 139       $parts  = split(" ",$row);
 140
 141       if(count($parts) != 10){
 142         print_red(_("Entry broken, skipped."));
 143       }else{
 144
 145         $entry = array();
 146         $entry['TASK_ID'] = $task_id;
 147         $entry['ID']      = $entry_id;
 148         $entry['Minute']  = $parts[0];
 149         $entry['Hour']    = $parts[1];
 150         $entry['Day']     = $parts[2];
 151         $entry['Month']   = $parts[3];
 152         $entry['Weekday'] = $parts[4];
 153         $entry['Action']  = $parts[5];
 154         $entry['OGroup']  = $parts[6];
 155         $entry['Zone']    = $parts[7];
 156         $entry['Section'] = $parts[8];
 157         if($entry['Action'] == "initial_install"){
 158           $tmp2 = split(";",$parts[9]);
 159           foreach($tmp2 as $target){
 160             $tmp = split(",",$target);
 161             $entry['Initial_Target'][]  = array(
 162                           "MAC"     => $tmp[0],
 163                           "IP"      => $tmp[1],
 164                           "NAME"    => $tmp[2]);
 165           }
 166           $entry['Target']  = array();
 167         }else{
 168           $entry['Initial_Target']  = array();
 169           $entry['Target']  = split(";",$parts[9]);
 170         }
 171         $entry['Comment'] = $desc;
 172         $this->a_queue[]   = $entry;
 173
 174       }
 175     }
 176
 177     /* Udpate ENTRY_ID -> id mapping */
 178     foreach($this->a_queue as $id => $entry){
 179       $this->id_entry_map[$entry['ID']] = $id;
 180     }
 181
 182     return(TRUE);
 183   }
 184
 185
 186   private function _save_data()
 187   {
 188     $this->_reset_error();
 189
 190     /* Check file accessibility */
 191     if(!file_exists($this->s_queue_file)){
 192       $this->set_error(sprintf(_("Can't locate gotomasses queue file '%s'."),$this->s_queue_file));
 193       return(FALSE);
 194     }
 195     if(!is_writeable($this->s_queue_file)){
 196       $this->set_error(sprintf(_("Can't write gotomasses queue file '%s'."),$this->s_queue_file));
 197       return(FALSE);
 198     }
 199     if($this->i_fileversion != filemtime($this->s_queue_file)){
 200       $this->set_error(_("The queue file was modified since last reload. Can't save changes."));
 201       return(FALSE);
 202     }
 203     $fp = @fopen($this->s_queue_file,"w");
 204     if(!$fp){
 205       $this->set_error(sprintf(_("Can't write gotomasses queue file '%s'."),$this->s_queue_file));
 206       return(FALSE);
 207     }
 208
 209     $str = "#GOsa generated file, please just modify if you really know what you do.";
 210     foreach($this->a_queue as $task){
 211       $str .= "\n#taskid:".trim($task['TASK_ID']).";entryid:".$task['ID'].";desc:".trim($task['Comment']);
 212       $str .= "\n";
 213       if($task['Action'] == "initial_install"){
 214         $str .= "*     *     *     *     *     ";
 215       }else{
 216         $str .= str_pad($task['Minute'] ,5," ")." ";
 217         $str .= str_pad($task['Hour']   ,5," ")." ";
 218         $str .= str_pad($task['Day']    ,5," ")." ";
 219         $str .= str_pad($task['Month']  ,5," ")." ";
 220         $str .= str_pad($task['Weekday'],5," ")." ";
 221       }
 222       $str .= str_pad($task['Action'] ,5," ")." ";
 223       $str .= str_pad($task['OGroup'] ,5," ")." ";
 224       $str .= str_pad($task['Zone']   ,5," ")." ";
 225       $str .= str_pad($task['Section'],5," ")." ";
 226       if($task['Action'] == "initial_install"){
 227         foreach($task['Initial_Target'] as $target){
 228           $str .= trim($target['MAC']).",".trim($target['IP']).",".trim($target['NAME']).";";
 229         }
 230       }else{
 231         foreach($task['Target'] as $target){
 232           $str .= $target.";";
 233         }
 234       }
 235       $str = preg_replace("/;$/","",$str);
 236     }
 237
 238     /* Write contents */
 239     $str .= "\n";
 240     fwrite($fp,$str);
 241     fclose($fp);
 242     $this->i_fileversion = filemtime($this->s_queue_file);
 243     return(TRUE);
 244   }
 245
 246   private function _add_entry($entry,$task_id = 0)
 247   {
 248     if($task_id == 0 || !is_numeric($task_id) || !isset($entry['TASK_ID']) || !is_numeric($entry['TASK_ID'])){
 249       $task_id=preg_replace("/[^0-9]*/","",microtime());
 250       $entry['TASK_ID'] = $task_id;
 251     }
 252     if(!isset($entry['ID']) || !is_numeric($entry['ID'])){
 253       $entry['ID'] = preg_replace("/[^0-9]*/","",microtime());
 254     }
 255     $this->a_queue[] = $entry;
 256
 257     return(true);
 258   }
 259
 260   public function get_entry($id)
 261   {
 262     if(isset($this->a_queue[$this->id_entry_map[$id]])){
 263       return($this->a_queue[$this->id_entry_map[$id]]);
 264     }else{
 265       $this->set_error(sprintf(_("Entry with id '%s' not found."),$id));
 266     }
 267   }
 268
 269   public function update_entry($id,$entry)
 270   {
 271     if(isset($this->a_queue[$this->id_entry_map[$id]])){
 272       $this->a_queue[$this->id_entry_map[$id]] = $entry;
 273       return($this->_save_data());
 274     }else{
 275       $this->set_error(sprintf(_("Could not update entry, entry with id '%s' not found."),$id));
 276     }
 277   }
 278
 279   public function id_exists($id)
 280   {
 281     return(isset($this->id_entry_map[$id]));
 282   }
 283
 284
 285   public function add($entry)
 286   {
 287     if(!$this->_add_entry($entry)){
 288       return(FALSE);
 289     }
 290     return($this->_save_data());
 291   }
 292
 293   public function add_multiple($array)
 294   {
 295     $task_id = preg_replace("/[^0-9]*/","",microtime());
 296     foreach($array as $entry){
 297       if(!$this->_add_entry($entry,$task_id)){
 298         return(FALSE);
 299       }
 300     }
 301     return($this->_save_data());
 302   }
 303
 304   public function fetch()
 305   {
 306     if(isset($this->a_queue[$this->i_pointer])){
 307       $p = $this->a_queue[$this->i_pointer];
 308       $this->i_pointer ++;
 309       return($p);
 310     }
 311     return(FALSE);
 312   }
 313
 314   public function load()
 315   {
 316     return($this->_reload_queue());
 317   }
 318
 319   public function save()
 320   {
 321     return($this->_save_data());
 322   }
 323
 324   private function _reset_error()
 325   {
 326     $this->b_error = FALSE;
 327     $this->s_error = "";
 328   }
 329
 330   private function set_error($str)
 331   {
 332     $this->b_error = TRUE;
 333     $this->s_error = $str;
 334   }
 335
 336   public function is_error()
 337   {
 338     return($this->b_error);
 339   }
 340
 341   public function get_error()
 342   {
 343     return($this->s_error);
 344   }
 345
 346 }
 347 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 348 ?>