Made it optional to create Dataset on commandline in constructor. Changed properties...

[omvzfs.git] / src / Dataset.php

diff --git a/src/Dataset.php b/src/Dataset.php
index f053faec54e05ff33781b8dcf4efb2a7378a598c..55358eae5630034ef24bfcebde265e7deba2ebce 100644 (file)
--- a/src/Dataset.php
+++ b/src/Dataset.php
@@ -18,7 +18,8 @@ class OMVModuleZFSDataset {
      * @access private
      */
     private $name;
-    /**
+       
+       /**
      * Mountpoint of the Dataset
      *
      * @var    string $mountPoint
@@ -42,18 +43,18 @@ class OMVModuleZFSDataset {
         *
         * @param string $name Name of the new Dataset
         * @param array $properties An associative array with properties to set when creating the Dataset
-        * @throws OMVModuleZFSException
+        * @param bool $create Should the Dataset be created on commandline? Defaults to false.
         *
         */
-       public function __construct($name, array $properties = null) {
-               $cmd = "zfs create " . $name . " 2>&1";
-               OMVUtil::exec($cmd,$out,$res);
-               if ($res) {
-                       throw new OMVModuleZFSException(implode("\n", $out));
+       public function __construct($name, array $properties = null, $create = false) {
+               if ($create) {
+                       $cmd = "zfs create -p " . $name . " 2>&1";
+                       $this->exec($cmd,$out,$res);
                }
                $this->name = $name;
+               $this->updateAllProperties();
                $this->setProperties($properties);
-               $this->mountPoint = $this->properties["mountpoint"];
+               $this->mountPoint = $this->properties["mountpoint"]["value"];
        }
 
        /**
@@ -80,7 +81,7 @@ class OMVModuleZFSDataset {
         * Get a single property value associated with the Dataset
         *
         * @param string $property Name of the property to fetch
-        * @return string
+        * @return array The returned array key 0=property value and key 1=property source.
         * @access public
         */
        public function getProperty($property) {
@@ -88,9 +89,11 @@ class OMVModuleZFSDataset {
        }
 
        /**
-        * Get an array of all properties associated with the Dataset
+        * 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.
         *
-        * @return array $properties
         * @access public
         */
        public function getProperties() {
@@ -107,46 +110,132 @@ class OMVModuleZFSDataset {
        public function setProperties($properties) {
                foreach ($properties as $newpropertyk => $newpropertyv) {
                        $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name;
-                       OMVUtil::exec($cmd,$out,$res);
-                       if ($res) {
-                               throw new OMVModuleZFSException(implode("\n", $out));
-                       }
-                       $this->properties["$newpropertyk"] = $newpropertyv;
+                       $this->exec($cmd,$out,$res);
+                       $this->updateProperty($newpropertyk);
                }
-               $this->updateAllProperties();
        }
 
        /**
         * Get all Dataset properties from commandline and update object properties attribute
         *
-        * @throws OMVModuleZFSException
+        * @return void
         * @access private
         */ 
        private function updateAllProperties() {
                $cmd = "zfs get -H all " . $this->name;
-               OMVUtil::exec($cmd,$out,$res);
-               if ($res) {
-                       throw new OMVModuleZFSException(implode("\n", $out));
-               }
+               $this->exec($cmd,$out,$res);
                unset($this->properties);
                foreach ($out as $line) {
                        $tmpary = preg_split('/\t+/', $line);
-                       $this->properties["$tmpary[1]"] = $tmpary[2];
+                       $this->properties["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]);
                }
        }
 
+       /**
+        * Get single Datset property from commandline and update object property attribute
+        *
+        * @param string $property Name of the property to update
+        * @return void
+        * @access private
+        */
+       private function updateProperty($property) {
+               $cmd = "zfs get -H " . $property . " " . $this->name;
+               $this->exec($cmd,$out,$res);
+               $tmpary = preg_split('/\t+/', $out[0]);
+               $this->properties["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]);
+       }
+
        /**
         * Destroy the Dataset.
         *
-        * @throws OMVModuleZFSException
+        * @return void
         * @access public
         */
        public function destroy() {
                $cmd = "zfs destroy " . $this->name;
-               OMVUtil::exec($cmd,$out,$res);
+               $this->exec($cmd,$out,$res);
+       }
+
+       /**
+        * Renames a Dataset
+        *
+        * @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.
+        *
+        * @param string $property Name of the property to inherit.
+        * @return void
+        * @access public
+        */
+       public function inherit($property) {
+               $cmd = "zfs inherit " . $property . " " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+               $this->updateProperty($property);
+       }
+
+       /**
+        * Upgrades the Dataset to latest filesystem version
+        *
+        * @return void
+        * @access public
+        */
+       public function upgrade() {
+               $cmd = "zfs upgrade " . $this->name . " 2>&1";
+               $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");
+       }
+
+
+       /**
+        * Helper function to execute a command and throw an exception on error
+        * (requires stderr redirected to stdout for proper exception message).
+        *
+        * @param string $cmd Command to execute
+        * @param array &$out If provided will contain output in an array
+        * @param int &$res If provided will contain Exit status of the command
+        * @return string Last line of output when executing the command
+        * @throws OMVModuleZFSException
+        * @access private
+        */
+       private function exec($cmd, &$out = null, &$res = null) {
+               $tmp = OMVUtil::exec($cmd, $out, $res);
                if ($res) {
                        throw new OMVModuleZFSException(implode("\n", $out));
                }
+               return $tmp;
        }
 
 }