Started work on Zvol class.

[omvzfs.git] / src / Dataset.php

diff --git a/src/Dataset.php b/src/Dataset.php
index 2ba1bede28e5f4af83fd2077eeb1c2632e243d38..8560f7495b25b8445c0b2faa0218505b8d195508 100644 (file)
--- a/src/Dataset.php
+++ b/src/Dataset.php
@@ -18,7 +18,8 @@ class OMVModuleZFSDataset {
      * @access private
      */
     private $name;
      * @access private
      */
     private $name;

-    /**
+       
+       /**

      * Mountpoint of the Dataset
      *
      * @var    string $mountPoint
      * Mountpoint of the Dataset
      *
      * @var    string $mountPoint


@@ -38,23 +39,25 @@ class OMVModuleZFSDataset {
        // Operations
 
        /**
        // 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 string $name Name of the new Dataset

-        * @param array $properties An associative array with properties to set when creating the Dataset
-        * @throws OMVModuleZFSException
-        *
+        * @return void
+        * @access public

         */
         */

-       public function __construct($name, array $properties = null) {
-               $cmd = "zfs create -p " . $name . " 2>&1";
-               OMVUtil::exec($cmd,$out,$res);
-               if ($res) {
-                       throw new OMVModuleZFSException(implode("\n", $out));
-               }
+       public function __construct($name) {

                $this->name = $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;
+                       }
+               }

        }
 
        /**
        }
 
        /**


@@ -110,10 +113,7 @@ class OMVModuleZFSDataset {
        public function setProperties($properties) {
                foreach ($properties as $newpropertyk => $newpropertyv) {
                        $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name;
        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->exec($cmd,$out,$res);

                        $this->updateProperty($newpropertyk);
                }
        }
                        $this->updateProperty($newpropertyk);
                }
        }


@@ -122,19 +122,15 @@ class OMVModuleZFSDataset {
         * Get all Dataset properties from commandline and update object properties attribute
         *
         * @return void
         * Get all Dataset properties from commandline and update object properties attribute
         *
         * @return void

-        * @throws OMVModuleZFSException

         * @access private
         */ 
        private function updateAllProperties() {
                $cmd = "zfs get -H all " . $this->name;
         * @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);
                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]);

                }
        }
 
                }
        }
 


@@ -143,32 +139,40 @@ class OMVModuleZFSDataset {
         *
         * @param string $property Name of the property to update
         * @return void
         *
         * @param string $property Name of the property to update
         * @return void

-        * @throws OMVModuleZFSException

         * @access private
         */
        private function updateProperty($property) {
                $cmd = "zfs get -H " . $property . " " . $this->name;
         * @access private
         */
        private function updateProperty($property) {
                $cmd = "zfs get -H " . $property . " " . $this->name;

-               OMVUtil::exec($cmd,$out,$res);
-               if ($res) {
-                       throw new OMVModuleZFSException(implode("\n", $out));
-               }
+               $this->exec($cmd,$out,$res);

                $tmpary = preg_split('/\t+/', $out[0]);
                $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"];

        }
 
        }
 

+

        /**
         * Destroy the Dataset.
         *
         * @return void
        /**
         * Destroy the Dataset.
         *
         * @return void

-        * @throws OMVModuleZFSException

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

-               OMVUtil::exec($cmd,$out,$res);
-               if ($res) {
-                       throw new OMVModuleZFSException(implode("\n", $out));
-               }
+               $this->exec($cmd,$out,$res);

        }
 
        /**
        }
 
        /**


@@ -176,15 +180,11 @@ class OMVModuleZFSDataset {
         *
         * @param string $newname New name of the Dataset
         * @return void
         *
         * @param string $newname New name of the Dataset
         * @return void

-        * @throws OMVModuleZFSException

         * @access public
         */
        public function rename($newname) {
                $cmd = "zfs rename -p " . $this->name . " " . $newname . " 2>&1";
         * @access public
         */
        public function rename($newname) {
                $cmd = "zfs rename -p " . $this->name . " " . $newname . " 2>&1";

-               OMVUtil::exec($cmd,$out,$res);
-               if ($res) {
-                       throw new OMVModuleZFSException(implode("\n", $out));
-               }
+               $this->exec($cmd,$out,$res);

                $this->name = $newname;
        }
 
                $this->name = $newname;
        }
 


@@ -194,16 +194,67 @@ class OMVModuleZFSDataset {
         *
         * @param string $property Name of the property to inherit.
         * @return void
         *
         * @param string $property Name of the property to inherit.
         * @return void

-        * @throws OMVModuleZFSException

         * @access public
         */
        public function inherit($property) {
                $cmd = "zfs inherit " . $property . " " . $this->name . " 2>&1";
         * @access public
         */
        public function inherit($property) {
                $cmd = "zfs inherit " . $property . " " . $this->name . " 2>&1";

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

-               $this->updateProperty($property);
+               return $tmp;

        }
 
 }
        }
 
 }