Introduce new helper function to further cleanup code

[omvzfs.git] / src / Dataset.php

diff --git a/src/Dataset.php b/src/Dataset.php
index afdd172c535a34827f4e4cc8814ce47b50ffb6e9..db3a165f848a6f8ee876e774c8bd5e6cf4e37359 100644 (file)
--- a/src/Dataset.php
+++ b/src/Dataset.php
@@ -1,5 +1,6 @@
 <?php
 require_once("Exception.php");
 <?php
 require_once("Exception.php");

+require_once("openmediavault/util.inc");

 
 /**
  * XXX detailed description
 
 /**
  * XXX detailed description


@@ -26,50 +27,30 @@ class OMVModuleZFSDataset {
     private $mountPoint;
 
     /**
     private $mountPoint;
 
     /**

-     * List of features assigned to the Dataset
+     * Array with properties assigned to the Dataset

      *
      *

-     * @var    array $features
+     * @var    array $properties

      * @access private
      */
      * @access private
      */

-    private $features;
+    private $properties;

 
        // Associations
        // Operations
 
        /**
         * Constructor
 
        // Associations
        // Operations
 
        /**
         * Constructor

-        * 
+        *

         * @param string $name Name of the new Dataset
         * @param string $name Name of the new Dataset

-        * @param array $features An array of features (strings) in the form <key>=<value> to set when creating the Dataset
-        * @throws OMVModuleZFSException
+        * @param array $properties An associative array with properties to set when creating the Dataset

         *
         */
         *
         */

-       public function __construct($name, array $features = null) {
-               $cmd = "zfs create ";
-               if (isset($features)) {
-                       foreach ($features as $feature) {
-                               $cmd .= "-o " . $feature . " ";
-                       }
-               }
-               $cmd .= $name . " 2>&1";
-               exec($cmd,$out,$res);
-               if ($res == 1) {
-                       throw new OMVModuleZFSException(implode("\n", $out));
-               }
-               unset($res);
+       public function __construct($name, array $properties = null) {
+               $cmd = "zfs create -p " . $name . " 2>&1";
+               $this->exec($cmd,$out,$res);

                $this->name = $name;
                $this->name = $name;

-               if (isset($features)) {
-                       $this->features = $features;
-                       foreach ($features as $feature) {
-                               if (preg_match('/^mountpoint\=(.*)$/', $feature, $res)) {
-                                       $this->mountPoint = $res[1];
-                                       continue;
-                               }
-                       }
-               } else {
-                       $this->features = array();
-                       $this->mountPoint = "/" . $name;
-               }
+               $this->updateAllProperties();
+               $this->setProperties($properties);
+               $this->mountPoint = $this->properties["mountpoint"][0];

        }
 
        /**
        }
 
        /**


@@ -93,57 +74,128 @@ class OMVModuleZFSDataset {
        }
 
        /**
        }
 
        /**

-        * Get an array of features associated with the Dataset
+        * Get a single property value associated with the Dataset

         *
         *

-        * @return array $features
+        * @param string $property Name of the property to fetch
+        * @return array The returned array key 0=property value and key 1=property source.

         * @access public
         */
         * @access public
         */

-       public function getFeatures() {
-               return $this->features;
+       public function getProperty($property) {
+               return $this->properties["$property"];
+       }
+
+       /**
+        * 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.
+        *
+        * @access public
+        */
+       public function getProperties() {
+               return $this->properties;

        }
 
        /**
         * Sets a number of Dataset properties. If a property is already set it will be updated with the new value.
         *
        }
 
        /**
         * Sets a number of Dataset properties. If a property is already set it will be updated with the new value.
         *

-        * @param  array $features An array of strings in format <key>=<value>
-        * @return void 
+        * @param  array $properties An associative array with properties to set
+        * @return void

         * @access public
         */
         * @access public
         */

-       public function setFeatures($features) {
-               foreach ($features as $newfeature) {
-                       $cmd = "zfs set " . $newfeature . " " . $this->name;
-                       exec($cmd,$out,$res);
-                       if ($res == 1) {
-                               throw new OMVModuleZFSException(implode("\n", $out));
-                       }
-                       $tmp = explode("=", $newfeature);
-                       $newfeaturek = $tmp[0];
-                       $found = false;
-                       for ($i=0; $i<count($this->features); $i++) {
-                               $tmp = explode("=", $this->features[$i]);
-                               $oldfeaturek = $tmp[0];
-                               if (strcmp($newfeaturek, $oldfeaturek) == 0) {
-                                       $this->features[$i] = $newfeature;
-                                       $found = true;
-                                       continue;
-                               }
-                       }
-                       if (!$found) {
-                               array_push($this->features, $newfeature);
-                       }
+       public function setProperties($properties) {
+               foreach ($properties as $newpropertyk => $newpropertyv) {
+                       $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name;
+                       $this->exec($cmd,$out,$res);
+                       $this->updateProperty($newpropertyk);
+               }
+       }
+
+       /**
+        * Get all Dataset properties from commandline and update object properties attribute
+        *
+        * @return void
+        * @access private
+        */ 
+       private function updateAllProperties() {
+               $cmd = "zfs get -H all " . $this->name;
+               $this->exec($cmd,$out,$res);
+               unset($this->properties);
+               foreach ($out as $line) {
+                       $tmpary = preg_split('/\t+/', $line);
+                       $this->properties["$tmpary[1]"] = array($tmpary[2], $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($tmpary[2], $tmpary[3]);
+       }
+

        /**
         * Destroy the Dataset.
         *
        /**
         * Destroy the Dataset.
         *

+        * @return void
+        * @access public

         */
        public function destroy() {
                $cmd = "zfs destroy " . $this->name;
         */
        public function destroy() {
                $cmd = "zfs destroy " . $this->name;

-               exec($cmd,$out,$res);
-               if ($res == 1) {
+               $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);
+       }
+
+       /**
+        * 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));
                }
                        throw new OMVModuleZFSException(implode("\n", $out));
                }

+               return $tmp;

        }
 
 }
        }
 
 }