Support for cloned filesystems and volumes.

[omvzfs.git] / src / Zvol.php

diff --git a/src/Zvol.php b/src/Zvol.php
index 9ace6cfd494c114fd36cbe93ea79a33ddb3e4738..8b65ac0e9ea21af76b62994a067ffdd91c101bac 100644 (file)
--- a/src/Zvol.php
+++ b/src/Zvol.php
@@ -1,6 +1,7 @@
 <?php
 require_once("Exception.php");
 require_once("openmediavault/util.inc");
+require_once("Snapshot.php");
 
 /**
  * XXX detailed description
@@ -36,6 +37,14 @@ class OMVModuleZFSZvol {
         */
        private $properties;
 
+       /**
+        * Array with Snapshots associated to the Zvol
+        * 
+        * @var     array $snapshots
+        * @access private
+        */
+       private $snapshots;
+
        // Associations
        // Operations
 
@@ -48,17 +57,25 @@ class OMVModuleZFSZvol {
         * @access public
         */
        public function __construct($name) {
+               $zvol_exists = true;
                $this->name = $name;
-               $qname = preg_quote($name, '/');
-               $cmd = "zfs list -H -t volume";
-               $this->exec($cmd, $out, $res);
-               foreach ($out as $line) {
-                       if (preg_match('/^' . $qname . '\t.*$/', $line)) {
-                               $this->updateAllProperties();
-                               $this->size = $this->properties["volsize"]["value"];
-                               continue;
+               $cmd = "zfs list -H -t volume " . $name . " 2>&1";
+               try {
+                       $this->exec($cmd, $out, $res);
+                       $this->updateAllProperties();
+                       $this->size = $this->properties["volsize"]["value"];
+               }
+               catch (OMVModuleZFSException $e) {
+                       $zvol_exists = false;
+               }
+               if ($zvol_exists) {
+                       $cmd = "zfs list -r -d 1 -o name -H -t snapshot " . $name . " 2>&1";
+                       $this->exec($cmd, $out2, $res2);
+                       foreach ($out2 as $line2) {
+                               $this->snapshots[$line2] = new OMVModuleZFSSnapshot($line2);
                        }
                }
+
        }
 
        /**
@@ -104,6 +121,20 @@ class OMVModuleZFSZvol {
                return $this->size;
        }
 
+       /**
+        * Get all Snapshots associated with the Zvol
+        * 
+        * @return array $snapshots
+        * @access public
+        */
+       public function getSnapshots() {
+               if (isset($this->snapshots)) {
+                       return $this->snapshots;
+               } else {
+                       return array();
+               }
+       }
+
        /**
         * Sets a number of Zvol properties. If a property is already set it will be updated with the new value.
         * 
@@ -113,7 +144,7 @@ class OMVModuleZFSZvol {
         */
        public function setProperties($properties) {
                foreach ($properties as $newpropertyk => $newpropertyv) {
-                       $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name;
+                       $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name . " 2>&1";
                        $this->exec($cmd,$out,$res);
                        $this->updateProperty($newpropertyk);
                }
@@ -126,7 +157,7 @@ class OMVModuleZFSZvol {
         * @access private
         */
        private function updateAllProperties() {
-               $cmd = "zfs get -H all " . $this->name;
+               $cmd = "zfs get -H all " . $this->name . " 2>&1";
                $this->exec($cmd,$out,$res);
                unset($this->properties);
                foreach ($out as $line) {
@@ -143,7 +174,7 @@ class OMVModuleZFSZvol {
         * @access private
         */
        private function updateProperty($property) {
-               $cmd = "zfs get -H " . $property . " " . $this->name;
+               $cmd = "zfs get -H " . $property . " " . $this->name . " 2>&1";
                $this->exec($cmd,$out,$res);
                $tmpary = preg_split('/\t+/', $out[0]);
                $this->properties["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]);
@@ -160,7 +191,7 @@ class OMVModuleZFSZvol {
         */
        public function create($size, array $properties = null, $sparse = null) {
                $cmd = "zfs create -p ";
-               if (isset($sparse) && $sparse == true) {
+               if ((isset($sparse)) && ($sparse == true)) {
                        $cmd .= "-s ";
                }       
                $cmd .= "-V " . $size . " " . $this->name . " 2>&1";
@@ -177,10 +208,23 @@ class OMVModuleZFSZvol {
         * @access public
         */
        public function destroy() {
-               $cmd = "zfs destroy " . $this->name;
+               $cmd = "zfs destroy " . $this->name . " 2>&1";
                $this->exec($cmd,$out,$res);
        }
 
+       /**
+        * Renames a Zvol
+        * 
+        * @param string $newname New name of the Dataset
+        * @return void
+        * @access public
+        */
+       public function rename($newname) {
+               $cmd = "zfs rename -p " . $this->name . " " . $newname . " 2>&1";
+               $this->exec($cmd,$out,$res);
+               $this->name = $newname;
+       }
+
        /**
         * Clears a previously set proporty and specifies that it should be
         * inherited from it's parent.
@@ -195,6 +239,76 @@ class OMVModuleZFSZvol {
                $this->updateProperty($property);
        }
 
+       /**
+        * Creates a Snapshot and adds it to the existing list of snapshots associated
+        * with the Zvol.
+        * 
+        * @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 Zvol.
+        * 
+        * @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]);
+       }
+       
+       /**
+       * Check if the Volume is a clone or not.
+       *
+       * @return bool
+       * @access public
+       */
+       public function isClone() {
+               $origin = $this->getProperty("origin");
+               if (strlen($origin["value"]) > 0) {
+                       return true;
+               } else {
+                       return false;
+               }
+       }
+
+       /**
+       * Get the origin of the Volume if it's a clone.
+       *
+       * @return string The name of the origin if it exists. Otherwise an empty string.
+       * @access public
+       */
+       public function getOrigin() {
+               if ($this->isClone()) {
+                       $origin = $this->getProperty("origin");
+                       return $origin['value'];
+               } else {
+                       return "";
+               }
+       }
+
+       /**
+       * Promotes the Volume if it's a clone.
+       *
+       * @return void
+       * @access public
+       */
+       public function promote() {
+               if ($this->isClone()) {
+                       $cmd = "zfs promote " . $this->name . " 2>&1";
+                       $this->exec($cmd,$out,$res);
+               }
+       }
+
        /**
         * Helper function to execute a command and throw an exception on error
         * (requires stderr redirected to stdout for proper exception message).