Corrected method desriptions in Dataset class.

[omvzfs.git] / src / Dataset.php

diff --git a/src/Dataset.php b/src/Dataset.php
index d6796e59217a55127df9d9aa6fa69095219b2f0b..2adc60c688902baa68c5d4f155701fe0aeb5465f 100644 (file)
--- a/src/Dataset.php
+++ b/src/Dataset.php
@@ -1,6 +1,7 @@
 <?php
 require_once("Exception.php");
 require_once("openmediavault/util.inc");
+require_once("Snapshot.php");
 
 /**
  * XXX detailed description
@@ -35,23 +36,45 @@ class OMVModuleZFSDataset {
      */
     private $properties;
 
+       /**
+        * Array with Snapshots associated to the Dataset
+        *
+        * @var         array $snapshots
+        * @access private
+        */
+       private $snapshots;
+
        // Associations
        // Operations
 
        /**
-        * Constructor
+        * Constructor. If the Dataset already exists in the system the object will be updated with all
+        * associated properties from commandline.
         *
         * @param string $name Name of the new Dataset
-        * @param array $properties An associative array with properties to set when creating the Dataset
-        *
+        * @return void
+        * @access public
         */
-       public function __construct($name, array $properties = null) {
-               $cmd = "zfs create -p " . $name . " 2>&1";
-               $this->exec($cmd,$out,$res);
+       public function __construct($name) {
                $this->name = $name;
-               $this->updateAllProperties();
-               $this->setProperties($properties);
-               $this->mountPoint = $this->properties["mountpoint"][0];
+               $qname = preg_quote($name, '/');
+               $cmd = "zfs list -H";
+               $this->exec($cmd, $out, $res);
+               foreach ($out as $line) {
+                       if (preg_match('/^' . $qname . '\t.*$/', $line)) {
+                               $this->updateAllProperties();
+                               $this->mountPoint = $this->properties["mountpoint"]["value"];
+                               continue;
+                       }
+               }
+               $qname = preg_quote($name . "@", '/');
+               $cmd = "zfs list -H -t snapshot";
+               $this->exec($cmd, $out, $res);
+               foreach ($out as $line) {
+                       if (preg_match('/^(' . $qname . '[^\s]+)\t.*$/', $line, $res)) {
+                               $this->snapshots[$res[1]] = new OMVModuleZFSSnapshot($res[1]);
+                       }
+               }
        }
 
        /**
@@ -75,10 +98,21 @@ class OMVModuleZFSDataset {
        }
 
        /**
-        * Get a single property value associated with the Dataset
+        * Get all Snapshots associated with the Dataset
         *
+        * @return array $snapshots
+        * @access public
+        */
+       public function getSnapshots() {
+               return $this->snapshots;
+       }
+
+       /**
+        * Get a single property value associated with the Dataset
+        * 
         * @param string $property Name of the property to fetch
-        * @return array The returned array key 0=property value and key 1=property source.
+        * @return array The returned array with the property. The property is an associative array with
+        * two elements, <value> and <source>.
         * @access public
         */
        public function getProperty($property) {
@@ -86,11 +120,10 @@ class OMVModuleZFSDataset {
        }
 
        /**
-        * Get an associative array of all properties associated with the Dataset.
-        *
-        * @return array $properties Each entry is an array where key 0=property value and key
-        * 1=property source.
-        *
+        * Get an associative array of all properties associated with the Snapshot
+        * 
+        * @return array $properties Each entry is an associative array with two elements
+        * <value> and <source>
         * @access public
         */
        public function getProperties() {
@@ -124,7 +157,7 @@ class OMVModuleZFSDataset {
                unset($this->properties);
                foreach ($out as $line) {
                        $tmpary = preg_split('/\t+/', $line);
-                       $this->properties["$tmpary[1]"] = array($tmpary[2], $tmpary[3]);
+                       $this->properties["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]);
                }
        }
 
@@ -139,7 +172,22 @@ class OMVModuleZFSDataset {
                $cmd = "zfs get -H " . $property . " " . $this->name;
                $this->exec($cmd,$out,$res);
                $tmpary = preg_split('/\t+/', $out[0]);
-               $this->properties["$tmpary[1]"] = array($tmpary[2], $tmpary[3]);
+               $this->properties["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]);
+       }
+
+       /**
+        * Craete a Dataset on commandline. Optionally provide a number of properties to set.
+        *
+        * @param array $properties Properties to set when creating the dataset.
+        * @return void
+        * @access public
+        */
+       public function create(array $properties = null) {
+               $cmd = "zfs create -p " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+               $this->updateAllProperties();
+               $this->setProperties($properties);
+               $this->mountPoint = $this->properties["mountpoint"]["value"];
        }
 
        /**
@@ -191,6 +239,57 @@ class OMVModuleZFSDataset {
                $this->exec($cmd,$out,$res);
        }
 
+       /**
+        * Mount the Dataset
+        *
+        * @return void
+        * @access public
+        */
+       public function mount() {
+               $cmd = "zfs mount " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+               $this->updateProperty("mounted");
+       }
+
+       /**
+        * Unmount the Dataset
+        *
+        * @return void
+        * @access public
+        */
+       public function unmount() {
+               $cmd = "zfs unmount " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+               $this->updateProperty("mounted");
+       }
+
+       /**
+        * Creates a Snapshot and adds it to the existing list of snapshots associated
+        * with the Dataset.
+        *
+        * @param string $snap_name Name of the Snapshot to create.
+        * @param array $properties Optional array of properties to set on Snapshot
+        * @return void
+        * @access public
+        */
+       public function addSnapshot($snap_name, array $properties = null) {
+               $snap = new OMVModuleZFSSnapshot($snap_name);
+               $snap->create($properties);
+               $this->snapshots[$snap_name] = $snap;
+       }
+
+       /**
+        * Destroys a Snapshot on commandline and removes it from the Dataset.
+        *
+        * @param string $snap_name Name of the Snapshot to delete.
+        * @return void
+        * @access public
+        */
+       public function deleteSnapshot($snap_name) {
+               $this->snapshots[$snap_name]->destroy();
+               unset($this->snapshots[$snap_name]);
+       }
+
        /**
         * Helper function to execute a command and throw an exception on error
         * (requires stderr redirected to stdout for proper exception message).