Added destroy method to Zvol class.

[omvzfs.git] / src / Zvol.php

diff --git a/src/Zvol.php b/src/Zvol.php
index 5c07ebb427d1ba9cc920c43f4d8a78b4bc35e4a7..c6fd20d5037364e976317fd7a8ad41a0bd205482 100644 (file)
--- a/src/Zvol.php
+++ b/src/Zvol.php
@@ -1,4 +1,6 @@
 <?php
+require_once("Exception.php");
+require_once("openmediavault/util.inc");
 
 /**
  * XXX detailed description
@@ -21,19 +23,11 @@ class OMVModuleZFSZvol {
        /**
         * Size of Zvol
         *
-        * @var int $size
+        * @var string $size
         * @access private
         */
        private $size;
 
-       /**
-        * Mountpoint of the Zvol
-        *
-        * @var    string $mountPoint
-        * @access private
-        */
-       private $mountPoint;
-
        /**
         * Array with properties assigned to the Zvol
         * 
@@ -44,55 +38,133 @@ class OMVModuleZFSZvol {
 
        // Associations
        // Operations
+
        /**
-        * XXX
-        *
-        * @return string XXX
+        * Constructor. If the Zvol already exists in the system the object will be updated with all
+        * associated properties from commandline.
+        * 
+        * @param string $name Name of the new Zvol
+        * @return void
         * @access public
         */
-       public function getName() {
-               trigger_error('Not Implemented!', E_USER_WARNING);
+       public function __construct($name) {
+               $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;
+                       }
+               }
        }
 
        /**
-        * XXX
-        *
-        * @return int XXX
+        * Return name of the Zvol
+        * 
+        * @return string $name
         * @access public
         */
-       public function getSize() {
-               trigger_error('Not Implemented!', E_USER_WARNING);
+       public function getName() {
+               return $this->name;
        }
 
        /**
-        * XXX
-        *
-        * @return string XXX
+        * Get a single property value associated with the Zvol
+        * 
+        * @param string $property Name of the property to fetch
+        * @return array The returned array with the property. The property is an associative array with
+        * two elements, <value> and <source>.
         * @access public
         */
-       public function getMountPoint() {
-               trigger_error('Not Implemented!', E_USER_WARNING);
+       public function getProperty($property) {
+               return $this->properties["$property"];
        }
 
        /**
-        * XXX
-        *
-        * @return list<Feature> XXX
+        * Get an associative array of all properties associated with the Zvol
+        * 
+        * @return array $properties Each entry is an associative array with two elements
+        * <value> and <source>
         * @access public
         */
        public function getProperties() {
-               trigger_error('Not Implemented!', E_USER_WARNING);
+               return $this->properties;
        }
 
        /**
-        * XXX
+        * Get the total size of the Zvol
         *
-        * @param   $list<Feature> XXX
-        * @return void XXX
+        * @return string $size
+        * @access public
+        */
+       public function getSize() {
+               return $this->size;
+       }
+
+       /**
+        * Sets a number of Zvol properties. If a property is already set it will be updated with the new value.
+        * 
+        * @param  array $properties An associative array with properties to set
+        * @return void
         * @access public
         */
        public function setProperties($properties) {
-               trigger_error('Not Implemented!', E_USER_WARNING);
+               foreach ($properties as $newpropertyk => $newpropertyv) {
+                       $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name;
+                       $this->exec($cmd,$out,$res);
+                       $this->updateProperty($newpropertyk);
+               }
+       }
+
+       /**
+        * Get all Zvol 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("value" => $tmpary[2], "source" => $tmpary[3]);
+               }
+       }
+
+       /**
+        * Create a Zvol on commandline. Optionally provide a number of properties to set.
+        * 
+        * @param string $size Size of the Zvol that should be created
+        * @param array $properties Properties to set when creatiing the dataset.
+        * @param boolean $sparse Defines if a sparse volume should be created.
+        * @return void
+        * @access public
+        */
+       public function create($size, array $properties = null, $sparse = null) {
+               $cmd = "zfs create -p ";
+               if (isset($sparse) && $sparse == true) {
+                       $cmd .= "-s ";
+               }       
+               $cmd .= "-V " . $size . " " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+               $this->updateAllProperties();
+               $this->setProperties($properties);
+               $this->size = $this->properties["volsize"]["value"];
+       }
+
+       /**
+        * Destroy the Zvol.
+        * 
+        * @return void
+        * @access public
+        */
+       public function destroy() {
+               $cmd = "zfs destroy " . $this->name;
+               $this->exec($cmd,$out,$res);
        }
 
        /**
@@ -113,7 +185,6 @@ class OMVModuleZFSZvol {
                }
                return $tmp;
        }
-
 }
 
 ?>