gosa-core/include/class_SnapshotHandler.inc

   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  */
  22
  23
  24 class SnapshotHandler {
  25
  26   var $config;
  27   var $isEnabled= false;
  28   var $snapshotBases= array();
  29
  30
  31   /* Create handler  */
  32   function SnapshotHandler(&$config)
  33   {
  34     $this->config = &$config;
  35     $config = $this->config;
  36
  37     if($config->get_cfg_value("enableSnapshots") == "true"){
  38
  39       /* Check if the snapshot_base is defined */
  40       if ($config->get_cfg_value("snapshotBase") == ""){
  41
  42         /* Send message if not done already */
  43         if(!session::is_set("snapshotFailMessageSend")){
  44           session::set("snapshotFailMessageSend",TRUE);
  45           msg_dialog::display(_("Configuration error"),
  46               sprintf(_("The snapshot functionality is enabled, but the required variable '%s' is not set."),
  47                 "snapshotBase"), ERROR_DIALOG);
  48         }
  49         return;
  50       }
  51
  52       /* Check if the snapshot_base is defined */
  53       if (!is_callable("gzcompress")){
  54
  55         /* Send message if not done already */
  56         if(!session::is_set("snapshotFailMessageSend")){
  57           session::set("snapshotFailMessageSend",TRUE);
  58           msg_dialog::display(_("Configuration error"),
  59               sprintf(_("The snapshot functionality is enabled, but the required compression module is missing. Please install '%s'."),"php5-zip / php5-gzip"), ERROR_DIALOG);
  60         }
  61         return;
  62       }
  63
  64       /* check if there are special server configurations for snapshots */
  65       if ($config->get_cfg_value("snapshotURI") != ""){
  66
  67         /* check if all required vars are available to create a new ldap connection */
  68         $missing = "";
  69         foreach(array("snapshotURI","snapshotAdminDn","snapshotAdminPassword","snapshotBase") as $var){
  70           if($config->get_cfg_value($var) == ""){
  71             $missing .= $var." ";
  72
  73             /* Send message if not done already */
  74             if(!session::is_set("snapshotFailMessageSend")){
  75               session::set("snapshotFailMessageSend",TRUE);
  76               msg_dialog::display(_("Configuration error"),
  77                   sprintf(_("The snapshot functionality is enabled, but the required variable '%s' is not set."),
  78                     $missing), ERROR_DIALOG);
  79             }
  80             return;
  81           }
  82         }
  83       }
  84       $this->isEnabled= true;
  85       return;
  86     }
  87   }
  88
  89
  90   function enabled()
  91   {
  92     return $this->isEnabled;
  93   }
  94
  95
  96   function setSnapshotBases($bases)
  97   {
  98     $this->snapshotBases= $bases;
  99   }
 100
 101
 102   function getSnapshotBases()
 103   {
 104     return $this->snapshotBases;
 105   }
 106
 107
 108   function get_snapshot_link()
 109   {
 110     $snapshotLdap= null;
 111
 112     /* check if there are special server configurations for snapshots */
 113     if($this->config->get_cfg_value("snapshotURI") != ""){
 114       $server= $this->config->get_cfg_value("snapshotURI");
 115       $user= $this->config->get_cfg_value("snapshotAdminDn");
 116       $password= $this->config->get_credentials($this->config->get_cfg_value("snapshotAdminPassword"));
 117       $snapshotLdap= new ldapMultiplexer(new LDAP($user,$password, $server));
 118     }
 119
 120     /* Prepare bases */
 121     $this->snapshotLdapBase= $this->config->get_cfg_value("snapshotBase");
 122     $snapshotLdap->cd($this->snapshotLdapBase);
 123     if (!$snapshotLdap->success()){
 124       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($snapshotLdap->get_error(), $this->snapshotLdapBase, "", get_class()));
 125     }
 126
 127     return $snapshotLdap;
 128   }
 129
 130
 131   function getDeletedSnapshots($objectBase, $raw= false)
 132   {
 133     // Skip if not enabled
 134     if(!$this->enabled()){
 135       return(array());
 136     }
 137
 138     // Load user info
 139     $ui= get_userinfo();
 140
 141     /* Create an additional ldap object which
 142        points to our ldap snapshot server */
 143     $ldap= $this->config->get_ldap_link();
 144     $ldap->cd($this->config->current['BASE']);
 145     $snapshotLdap= $this->get_snapshot_link();
 146     if (!$snapshotLdap) {
 147       $snapshotLdap= $ldap;
 148     }
 149
 150     // Initialize base
 151     $base= preg_replace("/".preg_quote($this->config->current['BASE'], '/')."$/",
 152                         "", $objectBase).$this->snapshotLdapBase;
 153
 154     /* Fetch all objects and check if they do not exist anymore */
 155     $objects= array();
 156     $snapshotLdap->cd($base);
 157     $snapshotLdap->ls("(objectClass=gosaSnapshotObject)", $base,
 158                       array("gosaSnapshotType", "gosaSnapshotTimestamp", "gosaSnapshotDN", "description"));
 159     while($entry = $snapshotLdap->fetch()){
 160
 161       $chk =  str_replace($base,"",$entry['dn']);
 162       if(preg_match("/,ou=/",$chk)) continue;
 163
 164       if(!isset($entry['description'][0])){
 165         $entry['description'][0]  = "";
 166       }
 167       $objects[] = $entry;
 168     }
 169
 170     /* Check if entry still exists */
 171     foreach($objects as $key => $entry){
 172       $ldap->cat($entry['gosaSnapshotDN'][0]);
 173       if($ldap->count()){
 174         unset($objects[$key]);
 175       }
 176     }
 177
 178     /* Format result as requested */
 179     if($raw) {
 180       return($objects);
 181     }else{
 182       $tmp = array();
 183       foreach($objects as $key => $entry){
 184         $tmp[base64_encode($entry['dn'])] = $entry['description'][0];
 185       }
 186     }
 187     return($tmp);
 188   }
 189
 190
 191   function hasSnapshots($dn)
 192   {
 193     return (count($this->getSnapshots($dn)) > 0);
 194   }
 195
 196
 197   function getSnapshots($dn, $raw= false)
 198   {
 199     // Empty if disabled
 200     if(!$this->enabled()){
 201       return(array());
 202     }
 203
 204     /* Create an additional ldap object which
 205        points to our ldap snapshot server */
 206     $ldap= $this->config->get_ldap_link();
 207     $ldap->cd($this->config->current['BASE']);
 208
 209     // Load snapshot LDAP connection
 210     $snapshotLdap= $this->get_snapshot_link();
 211     if (!$snapshotLdap) {
 212       $snapshotLdap= $ldap;
 213     }
 214
 215     $objectBase= preg_replace("/^[^,]*./","",$dn);
 216
 217     // Initialize base
 218     $base= preg_replace("/".preg_quote($this->config->current['BASE'], '/')."$/",
 219                         "", $objectBase).$this->snapshotLdapBase;
 220
 221     /* Fetch all objects with  gosaSnapshotDN=$dn */
 222     $snapshotLdap->cd($base);
 223     $snapshotLdap->ls("(&(objectClass=gosaSnapshotObject)(gosaSnapshotDN=".$dn."))",$base,
 224         array("gosaSnapshotType","gosaSnapshotTimestamp","gosaSnapshotDN","description"));
 225
 226     /* Put results into a list and add description if missing */
 227     $objects= array();
 228     while($entry = $snapshotLdap->fetch()){
 229       if(!isset($entry['description'][0])){
 230         $entry['description'][0]  = "";
 231       }
 232       $objects[] = $entry;
 233     }
 234
 235     /* Return the raw array, or format the result */
 236     if($raw){
 237       return($objects);
 238     }else{
 239       $tmp = array();
 240       foreach($objects as $entry){
 241         $tmp[base64_encode($entry['dn'])] = $entry['description'][0];
 242       }
 243     }
 244     return($tmp);
 245   }
 246
 247
 248    /* Create a snapshot of the current object */
 249   function create_snapshot($dn, $description= array())
 250   {
 251
 252     /* Check if snapshot functionality is enabled */
 253     if(!$this->snapshotEnabled()){
 254       return;
 255     }
 256
 257     /* Get configuration from gosa.conf */
 258     $config = $this->config;
 259
 260     /* Create lokal ldap connection */
 261     $ldap= $this->config->get_ldap_link();
 262     $ldap->cd($this->config->current['BASE']);
 263
 264     /* check if there are special server configurations for snapshots */
 265     if($config->get_cfg_value("snapshotURI") == ""){
 266
 267       /* Source and destination server are both the same, just copy source to dest obj */
 268       $ldap_to      = $ldap;
 269       $snapldapbase = $this->config->current['BASE'];
 270
 271     }else{
 272       $server         = $config->get_cfg_value("snapshotURI");
 273       $user           = $config->get_cfg_value("snapshotAdminDn");
 274       $password       = $this->config->get_credentials($config->get_cfg_value("snapshotAdminPassword"));
 275       $snapldapbase   = $config->get_cfg_value("snapshotBase");
 276
 277       $ldap_to        = new ldapMultiplexer(new LDAP($user,$password, $server));
 278       $ldap_to -> cd($snapldapbase);
 279
 280       if (!$ldap_to->success()){
 281         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
 282       }
 283
 284     }
 285
 286     /* check if the dn exists */
 287     if ($ldap->dn_exists($dn)){
 288
 289       /* Extract seconds & mysecs, they are used as entry index */
 290       list($usec, $sec)= explode(" ", microtime());
 291
 292       /* Collect some infos */
 293       $base           = $this->config->current['BASE'];
 294       $snap_base      = $config->get_cfg_value("snapshotBase");
 295       $base_of_object = preg_replace ('/^[^,]+,/i', '', $dn);
 296       $new_base       = preg_replace("/".preg_quote($base, '/')."$/","",$base_of_object).$snap_base;
 297
 298       /* Create object */
 299       $data             = $ldap->generateLdif(LDAP::fix($dn),
 300               "(&(!(objectClass=gosaDepartment))(!(objectClass=FAIclass)))",array(),'base');
 301
 302       $newName          = str_replace(".", "", $sec."-".$usec);
 303       $target= array();
 304       $target['objectClass']            = array("top", "gosaSnapshotObject");
 305       $target['gosaSnapshotData']       = gzcompress($data, 6);
 306       $target['gosaSnapshotType']       = "snapshot";
 307       $target['gosaSnapshotDN']         = $dn;
 308       $target['description']            = $description;
 309       $target['gosaSnapshotTimestamp']  = $newName;
 310
 311       /* Insert the new snapshot
 312          But we have to check first, if the given gosaSnapshotTimestamp
 313          is already used, in this case we should increment this value till there is
 314          an unused value. */
 315       $new_dn                           = "gosaSnapshotTimestamp=".$newName.",".$new_base;
 316       $ldap_to->cat($new_dn);
 317       while($ldap_to->count()){
 318         $ldap_to->cat($new_dn);
 319         $newName = str_replace(".", "", $sec."-".($usec++));
 320         $new_dn                           = "gosaSnapshotTimestamp=".$newName.",".$new_base;
 321         $target['gosaSnapshotTimestamp']  = $newName;
 322       }
 323       /* Inset this new snapshot */
 324       $ldap_to->cd($snapldapbase);
 325       $ldap_to->create_missing_trees($snapldapbase);
 326       $ldap_to->create_missing_trees($new_base);
 327       $ldap_to->cd($new_dn);
 328       $ldap_to->add($target);
 329       if (!$ldap_to->success()){
 330         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $new_dn, LDAP_ADD, get_class()));
 331       }
 332
 333       if (!$ldap->success()){
 334         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $new_base, "", get_class()));
 335       }
 336
 337     }
 338   }
 339
 340   function remove_snapshot($dn)
 341   {
 342     $ui       = get_userinfo();
 343     $old_dn   = $this->dn;
 344     $this->dn = $dn;
 345     $ldap = $this->config->get_ldap_link();
 346     $ldap->cd($this->config->current['BASE']);
 347     $ldap->rmdir_recursive($this->dn);
 348     if(!$ldap->success()){
 349       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $this->dn));
 350     }
 351     $this->dn = $old_dn;
 352   }
 353  /* returns true if snapshots are enabled, and false if it is disalbed
 354      There will also be some errors psoted, if the configuration failed */
 355   function snapshotEnabled()
 356   {
 357     return $this->config->snapshotEnabled();
 358   }
 359
 360
 361   /* Return available snapshots for the given base
 362    */
 363   function Available_SnapsShots($dn,$raw = false)
 364   {
 365     if(!$this->snapshotEnabled()) return(array());
 366
 367     /* Create an additional ldap object which
 368        points to our ldap snapshot server */
 369     $ldap= $this->config->get_ldap_link();
 370     $ldap->cd($this->config->current['BASE']);
 371     $cfg= &$this->config->current;
 372
 373     /* check if there are special server configurations for snapshots */
 374     if($this->config->get_cfg_value("snapshotURI") == ""){
 375       $ldap_to      = $ldap;
 376     }else{
 377       $server         = $this->config->get_cfg_value("snapshotURI");
 378       $user           = $this->config->get_cfg_value("snapshotAdminDn");
 379       $password       = $this->config->get_credentials($this->config->get_cfg_value("snapshotAdminPassword"));
 380       $snapldapbase   = $this->config->get_cfg_value("snapshotBase");
 381       $ldap_to        = new ldapMultiplexer(new LDAP($user,$password, $server));
 382       $ldap_to -> cd($snapldapbase);
 383       if (!$ldap_to->success()){
 384         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
 385       }
 386     }
 387     /* Prepare bases and some other infos */
 388     $base           = $this->config->current['BASE'];
 389     $snap_base      = $this->config->get_cfg_value("snapshotBase");
 390     $base_of_object = preg_replace ('/^[^,]+,/i', '', $dn);
 391     $new_base       = preg_replace("/".preg_quote($base, '/')."$/","",$base_of_object).$snap_base;
 392     $tmp            = array();
 393
 394     /* Fetch all objects with  gosaSnapshotDN=$dn */
 395     $ldap_to->cd($new_base);
 396     $ldap_to->ls("(&(objectClass=gosaSnapshotObject)(gosaSnapshotDN=".$dn."))",$new_base,
 397         array("gosaSnapshotType","gosaSnapshotTimestamp","gosaSnapshotDN","description"));
 398
 399     /* Put results into a list and add description if missing */
 400     while($entry = $ldap_to->fetch()){
 401       if(!isset($entry['description'][0])){
 402         $entry['description'][0]  = "";
 403       }
 404       $tmp[] = $entry;
 405     }
 406
 407     /* Return the raw array, or format the result */
 408     if($raw){
 409       return($tmp);
 410     }else{
 411       $tmp2 = array();
 412       foreach($tmp as $entry){
 413         $tmp2[base64_encode($entry['dn'])] = $entry['description'][0];
 414       }
 415     }
 416     return($tmp2);
 417   }
 418  function getAllDeletedSnapshots($base_of_object,$raw = false)
 419   {
 420     if(!$this->snapshotEnabled()) return(array());
 421
 422     /* Create an additional ldap object which
 423        points to our ldap snapshot server */
 424     $ldap= $this->config->get_ldap_link();
 425     $ldap->cd($this->config->current['BASE']);
 426     $cfg= &$this->config->current;
 427
 428     /* check if there are special server configurations for snapshots */
 429     if($this->config->get_cfg_value("snapshotURI") == ""){
 430       $ldap_to      = $ldap;
 431     }else{
 432       $server         = $this->config->get_cfg_value("snapshotURI");
 433       $user           = $this->config->get_cfg_value("snapshotAdminDn");
 434       $password       = $this->config->get_credentials($this->config->get_cfg_value("snapshotAdminPassword"));
 435       $snapldapbase   = $this->config->get_cfg_value("snapshotBase");
 436       $ldap_to        = new ldapMultiplexer(new LDAP($user,$password, $server));
 437       $ldap_to -> cd($snapldapbase);
 438       if (!$ldap_to->success()){
 439         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
 440       }
 441     }
 442
 443     /* Prepare bases */
 444     $base           = $this->config->current['BASE'];
 445     $snap_base      = $this->config->get_cfg_value("snapshotBase");
 446     $new_base       = preg_replace("/".preg_quote($base, '/')."$/","",$base_of_object).$snap_base;
 447   /* Fetch all objects and check if they do not exist anymore */
 448     $ui = get_userinfo();
 449     $tmp = array();
 450     $ldap_to->cd($new_base);
 451     $ldap_to->ls("(objectClass=gosaSnapshotObject)",$new_base,array("gosaSnapshotType","gosaSnapshotTimestamp","gosaSnapshotDN","description"));
 452     while($entry = $ldap_to->fetch()){
 453
 454       $chk =  str_replace($new_base,"",$entry['dn']);
 455       if(preg_match("/,ou=/",$chk)) continue;
 456
 457       if(!isset($entry['description'][0])){
 458         $entry['description'][0]  = "";
 459       }
 460       $tmp[] = $entry;
 461     }
 462
 463     /* Check if entry still exists */
 464     foreach($tmp as $key => $entry){
 465       $ldap->cat($entry['gosaSnapshotDN'][0]);
 466       if($ldap->count()){
 467         unset($tmp[$key]);
 468       }
 469     }
 470
 471     /* Format result as requested */
 472     if($raw) {
 473       return($tmp);
 474     }else{
 475       $tmp2 = array();
 476       foreach($tmp as $key => $entry){
 477         $tmp2[base64_encode($entry['dn'])] = $entry['description'][0];
 478       }
 479     }
 480     return($tmp2);
 481   }
 482
 483
 484  /* Restore selected snapshot */
 485   function restore_snapshot($dn)
 486   {
 487     if(!$this->snapshotEnabled()) return(array());
 488
 489     $ldap= $this->config->get_ldap_link();
 490     $ldap->cd($this->config->current['BASE']);
 491     $cfg= &$this->config->current;
 492
 493     /* check if there are special server configurations for snapshots */
 494     if($this->config->get_cfg_value("snapshotURI") == ""){
 495       $ldap_to      = $ldap;
 496     }else{
 497       $server         = $this->config->get_cfg_value("snapshotURI");
 498       $user           = $this->config->get_cfg_value("snapshotAdminDn");
 499       $password       = $this->config->get_credentials($this->config->get_cfg_value("snapshotAdminPassword"));
 500       $snapldapbase   = $this->config->get_cfg_value("snapshotBase");
 501       $ldap_to        = new ldapMultiplexer(new LDAP($user,$password, $server));
 502       $ldap_to -> cd($snapldapbase);
 503       if (!$ldap_to->success()){
 504         msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap_to->get_error(), $snapldapbase, "", get_class()));
 505       }
 506     }
 507
 508     /* Get the snapshot */
 509     $ldap_to->cat($dn);
 510     $restoreObject = $ldap_to->fetch();
 511
 512     /* Prepare import string */
 513     $data  = gzuncompress($ldap_to->get_attribute($dn,'gosaSnapshotData'));
 514
 515     /* Import the given data */
 516     $err = "";
 517     $ldap->import_complete_ldif($data,$err,false,false);
 518     if (!$ldap->success()){
 519       msg_dialog::display(_("LDAP error"), msgPool::ldaperror($ldap->get_error(), $dn, "", get_class()));
 520     }
 521   }
 522
 523
 524 }
 525 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 526 ?>